A checklist of the release assets that exist and the ones the CI could still build
Nothing said whether a release was finished. A pipeline step can fail, a
platform can gain a target, a title can be published from a laptop — and the
catalog happily serves a release with three of its seven assets. The only way
to find out was to open `/api/softwares/<name>/builds` one name at a time.
$ bin/rails warp_engine:builds:check
rabbitroller ebitengine v1.1.1 1/7
[x] html
[ ] win_x86
[ ] win_x64
[ ] linux_x64
[ ] linux_arm64
[-] mac_x64
[-] mac_arm64
The CI can build these and the release does not have them:
rabbitroller v1.1.1 (ebitengine): win_x86, win_x64, linux_x64, linux_arm64
5 softwares, 5 releases, 14/32 assets present, 16 missing from CI-built kinds
The third marker is the point. Two different questions were being conflated:
what the **updater** can ingest (`Platform#expected_kinds`) and what the
**pipeline** actually produces. For six of the seven platforms they are the
same list; for ebitengine they are not — the updater accepts macOS builds, the
Woodpecker builder cannot cross-compile them (osxcross), so `mac_x64` and
`mac_arm64` would be reported as gaps on every ebitengine release, for ever.
`[ ]` is now a real gap and `[-]` is "upload it by hand or not at all", so the
list stays worth reading.
That knowledge is data, next to the templates that produce it:
`PipelineConfig::BUILT_KINDS`, reachable through the adapter as
`built_kinds(platform)`. An adapter that cannot answer — no CI configured, a
platform with no builder — returns nil, and then nothing is excused: every
missing kind counts as a gap.
`WarpEngine::AssetCoverage` computes it (`#rows`, `#missing_rows`, `#totals`)
and `AssetCoverageChecklist` renders it, so the numbers are testable without a
terminal. Options are env vars: NAME, PLATFORM, RELEASES=all, ONLY=missing, and
STRICT=1 for a non-zero exit in CI. The default is the newest release per
software, using the same non-`dev-` rule the catalog API uses for "latest".
33 new examples, including two that keep BUILT_KINDS honest: every claimed kind
has to be a kind the updater knows, and has to appear in the platform's rendered
pipeline. Adding a platform without teaching this list about it fails the suite.
Ships in 0.8.0.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe WarpEngine::CI::Woodpecker::PipelineConfig do
|
||||
BUILT_KINDS = described_class::BUILT_KINDS
|
||||
|
||||
def self.fragment_for(kind)
|
||||
case kind
|
||||
when "html" then ".html.zip"
|
||||
when "docs" then "-docs.zip"
|
||||
when "cartridge", "source" then nil
|
||||
else kind.tr("_", "-")
|
||||
end
|
||||
end
|
||||
|
||||
def config_for(platform)
|
||||
described_class.new(platforms: { platform => { builder: "builder:latest", exporter: "exporter:latest" } })
|
||||
end
|
||||
|
||||
it "knows every platform in the registry" do
|
||||
expect(BUILT_KINDS.keys).to match_array(WarpEngine::Platform.names)
|
||||
end
|
||||
|
||||
WarpEngine::Platform::NAMES.each do |platform|
|
||||
context platform do
|
||||
let(:kinds) { BUILT_KINDS.fetch(platform) }
|
||||
let(:rendered) do
|
||||
config_for(platform).render(platform: platform, name: "example", update_server: "https://example.test")
|
||||
end
|
||||
|
||||
it "claims only kinds the updater knows how to ingest" do
|
||||
expect(kinds - WarpEngine::Platform.find(platform).expected_kinds).to be_empty
|
||||
end
|
||||
|
||||
it "claims only kinds the pipeline actually packages" do
|
||||
kinds.each do |kind|
|
||||
fragment = self.class.fragment_for(kind)
|
||||
next if fragment.nil?
|
||||
|
||||
expect(rendered).to include(fragment), "#{platform}: nothing in the pipeline produces #{kind}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#built_kinds" do
|
||||
it "answers with the kinds of a platform it has a builder for" do
|
||||
expect(config_for("tic80").built_kinds("tic80")).to include("cartridge", "html", "win_x64")
|
||||
end
|
||||
|
||||
it "answers nil for a platform with no builder configured, so nothing is excused" do
|
||||
expect(config_for("tic80").built_kinds("godot")).to be_nil
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,52 @@
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe WarpEngine::AssetCoverageChecklist do
|
||||
let(:software) { create(:software, name: "rabbitroller", platform: "ebitengine") }
|
||||
|
||||
before do
|
||||
release = create(:release, software: software, version: "1.1.1")
|
||||
WarpEngine::ReleaseAsset.create!(release: release, kind: "html", path: "/s/rabbitroller-1.1.1")
|
||||
|
||||
ci = instance_double(WarpEngine::CI::Woodpecker::Adapter)
|
||||
allow(ci).to receive(:built_kinds) { |platform| WarpEngine::CI::Woodpecker::PipelineConfig::BUILT_KINDS[platform] }
|
||||
allow(WarpEngine).to receive(:ci).and_return(ci)
|
||||
end
|
||||
|
||||
def output(**options) = described_class.new(WarpEngine::AssetCoverage.new(**options)).to_s
|
||||
|
||||
it "checks off what is there and leaves the rest open" do
|
||||
lines = output.lines.map(&:chomp)
|
||||
|
||||
expect(lines).to include("rabbitroller ebitengine v1.1.1 1/7")
|
||||
expect(lines).to include(" [x] html")
|
||||
expect(lines).to include(" [ ] linux_arm64")
|
||||
expect(lines).to include(" [-] mac_arm64")
|
||||
end
|
||||
|
||||
it "lists what the CI could build and the release does not have" do
|
||||
expect(output).to include("The CI can build these and the release does not have them:")
|
||||
expect(output).to include("rabbitroller v1.1.1 (ebitengine): win_x86, win_x64, linux_x64, linux_arm64")
|
||||
end
|
||||
|
||||
it "counts the assets and says how many the CI does not build" do
|
||||
expect(output).to include("1 softwares, 1 releases, 1/7 assets present, 4 missing from CI-built kinds")
|
||||
expect(output).to include("2 assets are expected but this CI does not build them")
|
||||
end
|
||||
|
||||
it "shows only the incomplete releases when asked" do
|
||||
complete = create(:software, name: "pong", platform: "c64")
|
||||
release = create(:release, software: complete, version: "0.1")
|
||||
WarpEngine::ReleaseAsset.create!(release: release, kind: "cartridge", path: "/s/pong-0.1.prg")
|
||||
|
||||
text = described_class.new(WarpEngine::AssetCoverage.new, only_missing: true).to_s
|
||||
|
||||
expect(text).to include("rabbitroller")
|
||||
expect(text).not_to include("pong")
|
||||
end
|
||||
|
||||
it "says so when there is nothing to report" do
|
||||
text = described_class.new(WarpEngine::AssetCoverage.new(name: "nothing-here")).to_s
|
||||
|
||||
expect(text).to include("Nothing to report.")
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,139 @@
|
||||
require "rails_helper"
|
||||
|
||||
RSpec.describe WarpEngine::AssetCoverage do
|
||||
def release_with(software:, version:, kinds:, created_at: Time.current)
|
||||
release = create(:release, software: software, version: version, created_at: created_at)
|
||||
kinds.each { |kind| WarpEngine::ReleaseAsset.create!(release: release, kind: kind, path: "/s/#{version}-#{kind}") }
|
||||
release
|
||||
end
|
||||
|
||||
describe "#rows" do
|
||||
it "says which expected kinds are present and which are missing" do
|
||||
software = create(:software, name: "impostor", platform: "tic80")
|
||||
release_with(software: software, version: "1.0", kinds: %w[cartridge source html])
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row.software).to eq(software)
|
||||
expect(row.expected).to eq(WarpEngine::Platform.find("tic80").expected_kinds)
|
||||
expect(row.present).to contain_exactly("cartridge", "source", "html")
|
||||
expect(row.missing).to contain_exactly("docs", "win_x64", "linux_x64", "mac_x64")
|
||||
expect(row).not_to be_complete
|
||||
end
|
||||
|
||||
it "calls a release with every expected asset complete" do
|
||||
software = create(:software, name: "pong", platform: "c64")
|
||||
release_with(software: software, version: "0.1.0", kinds: %w[cartridge])
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row).to be_complete
|
||||
expect(row.missing).to be_empty
|
||||
expect(row).not_to be_actionable
|
||||
end
|
||||
|
||||
it "reports an asset the platform does not expect" do
|
||||
software = create(:software, name: "phasergame", platform: "phaser")
|
||||
release_with(software: software, version: "1.0", kinds: %w[html win_x64])
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row.unexpected).to eq([ "win_x64" ])
|
||||
end
|
||||
|
||||
it "reports a software with no release at all" do
|
||||
create(:software, name: "empty", platform: "godot")
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row).not_to be_released
|
||||
expect(row).not_to be_actionable
|
||||
end
|
||||
|
||||
it "expects nothing from a platform the registry does not know" do
|
||||
software = create(:software, name: "amigagame", platform: "tic80")
|
||||
software.update_column(:platform, "amiga")
|
||||
release_with(software: software, version: "1.0", kinds: [])
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row).to be_unknown_platform
|
||||
expect(row.expected).to be_empty
|
||||
end
|
||||
|
||||
it "checks the newest release by default, and every release on demand" do
|
||||
software = create(:software, name: "rabbitroller", platform: "ebitengine")
|
||||
release_with(software: software, version: "1.0.0", kinds: %w[html], created_at: 2.days.ago)
|
||||
release_with(software: software, version: "1.1.1", kinds: %w[html win_x64], created_at: 1.day.ago)
|
||||
|
||||
expect(described_class.new.rows.map(&:version)).to eq([ "1.1.1" ])
|
||||
expect(described_class.new(releases: :all).rows.map(&:version)).to eq([ "1.1.1", "1.0.0" ])
|
||||
end
|
||||
|
||||
it "does not call a dev build the latest release" do
|
||||
software = create(:software, name: "rabbitroller", platform: "ebitengine")
|
||||
release_with(software: software, version: "1.1.1", kinds: %w[html], created_at: 2.days.ago)
|
||||
release_with(software: software, version: "dev-abc123-master", kinds: %w[html], created_at: 1.hour.ago)
|
||||
|
||||
expect(described_class.new.rows.map(&:version)).to eq([ "1.1.1" ])
|
||||
end
|
||||
|
||||
it "narrows to one software or one platform" do
|
||||
create(:software, name: "impostor", platform: "tic80")
|
||||
create(:software, name: "rabbitroller", platform: "ebitengine")
|
||||
|
||||
expect(described_class.new(name: "impostor").rows.map { |r| r.software.name }).to eq([ "impostor" ])
|
||||
expect(described_class.new(platform: "ebitengine").rows.map { |r| r.software.name }).to eq([ "rabbitroller" ])
|
||||
end
|
||||
end
|
||||
|
||||
describe "what the CI can build" do
|
||||
let(:software) { create(:software, name: "rabbitroller", platform: "ebitengine") }
|
||||
|
||||
before { release_with(software: software, version: "1.1.1", kinds: %w[html]) }
|
||||
|
||||
it "separates the kinds the pipeline builds from the ones it cannot" do
|
||||
ci = instance_double(WarpEngine::CI::Woodpecker::Adapter)
|
||||
allow(ci).to receive(:built_kinds).with("ebitengine")
|
||||
.and_return(%w[html win_x86 win_x64 linux_x64 linux_arm64])
|
||||
allow(WarpEngine).to receive(:ci).and_return(ci)
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row.buildable_missing).to contain_exactly("win_x86", "win_x64", "linux_x64", "linux_arm64")
|
||||
expect(row.manual_missing).to contain_exactly("mac_x64", "mac_arm64")
|
||||
expect(row.state_of("linux_arm64")).to eq(:missing)
|
||||
expect(row.state_of("mac_x64")).to eq(:manual)
|
||||
expect(row.state_of("html")).to eq(:present)
|
||||
end
|
||||
|
||||
it "treats every missing kind as buildable when the CI cannot say" do
|
||||
ci = instance_double(WarpEngine::CI::Woodpecker::Adapter)
|
||||
allow(ci).to receive(:built_kinds).and_return(nil)
|
||||
allow(WarpEngine).to receive(:ci).and_return(ci)
|
||||
|
||||
row = described_class.new.rows.first
|
||||
|
||||
expect(row.buildable_missing).to eq(row.missing)
|
||||
expect(row.manual_missing).to be_empty
|
||||
end
|
||||
end
|
||||
|
||||
describe "#totals" do
|
||||
it "counts releases, assets and the softwares that are short of one" do
|
||||
tic80 = create(:software, name: "impostor", platform: "tic80")
|
||||
release_with(software: tic80, version: "1.0", kinds: %w[cartridge source html docs win_x64 linux_x64 mac_x64])
|
||||
c64 = create(:software, name: "pong", platform: "c64")
|
||||
release_with(software: c64, version: "0.1", kinds: [])
|
||||
|
||||
totals = described_class.new.totals
|
||||
|
||||
expect(totals[:softwares]).to eq(2)
|
||||
expect(totals[:releases]).to eq(2)
|
||||
expect(totals[:expected]).to eq(8)
|
||||
expect(totals[:present]).to eq(7)
|
||||
expect(totals[:missing]).to eq(1)
|
||||
expect(totals[:incomplete_softwares]).to eq(1)
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user