e56735a171
The `ElectronBuilder` strategy uses `YAML#safe_load` to parse YAML content and this limits deserialization to appropriate classes. We recently encountered a `Tried to load unspecified class: Time` error when using the `ElectronBuilder` strategy on a `latest-mac.yml` file containing `releaseDate: 2022-12-01T02:02:46.419Z`. The electron-builder YAML files we usually encounter use single quotes around the `releaseDate` value to ensure it's treated as a string (e.g., `releaseDate: '2022-10-12T17:55:26.718Z'`) and this is what we do in `electron_builder_spec.rb`. The aforementioned YAML file doesn't use single quotes around the value, so it's treated as a timestamp and apparently this makes Psych use `Time` (which `#safe_load` doesn't allow by default). Seeing as we can't control the YAML content and there's a chance we may encounter other files like this in the future, this commit modifies the related `#safe_load` call to allow `Time` (and `Date` for good measure). This will resolve the aforementioned error and allow the `ElectronBuilder` strategy to work as expected in this scenario.
103 lines
3.6 KiB
Ruby
103 lines
3.6 KiB
Ruby
# typed: false
|
|
# frozen_string_literal: true
|
|
|
|
require "livecheck/strategy"
|
|
|
|
describe Homebrew::Livecheck::Strategy::ElectronBuilder do
|
|
subject(:electron_builder) { described_class }
|
|
|
|
let(:yaml_url) { "https://www.example.com/example/latest-mac.yml" }
|
|
let(:non_yaml_url) { "https://brew.sh/test" }
|
|
|
|
let(:electron_builder_yaml) {
|
|
<<~EOS
|
|
version: 1.2.3
|
|
files:
|
|
- url: Example-1.2.3-mac.zip
|
|
sha512: MDXR0pxozBJjxxbtUQJOnhiaiiQkryLAwtcVjlnNiz30asm/PtSxlxWKFYN3kV/kl+jriInJrGypuzajTF6XIA==
|
|
size: 92031237
|
|
blockMapSize: 96080
|
|
- url: Example-1.2.3.dmg
|
|
sha512: k6WRDlZEfZGZHoOfUShpHxXZb5p44DRp+FAO2FXNx2kStZvyW9VuaoB7phPMfZpcMKrzfRfncpP8VEM8OB2y9g==
|
|
size: 94972630
|
|
path: Example-1.2.3-mac.zip
|
|
sha512: MDXR0pxozBJjxxbtUQJOnhiaiiQkryLAwtcVjlnNiz30asm/PtSxlxWKFYN3kV/kl+jriInJrGypuzajTF6XIA==
|
|
releaseDate: '2000-01-01T00:00:00.000Z'
|
|
EOS
|
|
}
|
|
|
|
let(:electron_builder_yaml_with_timestamp) {
|
|
# An electron-builder YAML file may use a timestamp instead of an explicit
|
|
# string value (with quotes) for `releaseDate`, so we need to make sure that
|
|
# `ElectronBuilder#versions_from_content` won't encounter an error in this
|
|
# scenario (e.g. `Tried to load unspecified class: Time`).
|
|
electron_builder_yaml.sub(/releaseDate:\s*'([^']+)'/, 'releaseDate: \1')
|
|
}
|
|
|
|
let(:mac_regex) { /Example[._-]v?(\d+(?:\.\d+)+)[._-]mac\.zip/i }
|
|
|
|
let(:versions) { ["1.2.3"] }
|
|
|
|
describe "::match?" do
|
|
it "returns true for a YAML file URL" do
|
|
expect(electron_builder.match?(yaml_url)).to be true
|
|
end
|
|
|
|
it "returns false for non-YAML URL" do
|
|
expect(electron_builder.match?(non_yaml_url)).to be false
|
|
end
|
|
end
|
|
|
|
describe "::versions_from_content" do
|
|
it "returns an empty array if content is blank" do
|
|
expect(electron_builder.versions_from_content("")).to eq([])
|
|
end
|
|
|
|
it "returns an array of version strings when given YAML text" do
|
|
expect(electron_builder.versions_from_content(electron_builder_yaml)).to eq(versions)
|
|
expect(electron_builder.versions_from_content(electron_builder_yaml_with_timestamp)).to eq(versions)
|
|
end
|
|
|
|
it "returns an array of version strings when given YAML text and a block" do
|
|
# Returning a string from block
|
|
expect(
|
|
electron_builder.versions_from_content(electron_builder_yaml) do |yaml|
|
|
yaml["version"].sub("3", "4")
|
|
end,
|
|
).to eq(["1.2.4"])
|
|
|
|
# Returning an array of strings from block
|
|
expect(electron_builder.versions_from_content(electron_builder_yaml) { versions }).to eq(versions)
|
|
end
|
|
|
|
it "returns an array of version strings when given YAML text, a regex, and a block" do
|
|
# Returning a string from block
|
|
expect(
|
|
electron_builder.versions_from_content(electron_builder_yaml, mac_regex) do |yaml, regex|
|
|
yaml["path"][regex, 1]
|
|
end,
|
|
).to eq(versions)
|
|
|
|
# Returning an array of strings from block
|
|
expect(
|
|
electron_builder.versions_from_content(electron_builder_yaml, mac_regex) do |yaml, regex|
|
|
yaml["files"]&.map do |file|
|
|
next if file["url"].blank?
|
|
|
|
file["url"][regex, 1]
|
|
end
|
|
end,
|
|
).to eq(versions)
|
|
end
|
|
|
|
it "allows a nil return from a block" do
|
|
expect(electron_builder.versions_from_content(electron_builder_yaml) { next }).to eq([])
|
|
end
|
|
|
|
it "errors on an invalid return type from a block" do
|
|
expect { electron_builder.versions_from_content(electron_builder_yaml) { 123 } }
|
|
.to raise_error(TypeError, Homebrew::Livecheck::Strategy::INVALID_BLOCK_RETURN_VALUE_MSG)
|
|
end
|
|
end
|
|
end
|