Skip to content

Commit

Permalink
fix: deprecate "chisel-v1" format (#16)
Browse files Browse the repository at this point in the history 
* fix: depreciate "chisel-v1" format

This commit depreciates support for the "chisel-v1" format in chisel.
Notably the following fields/values are no longer supported:

    - The "chisel-v1" value for top-level field "format". Use "v1"
      instead.
    - The "<archive>.v1-public-keys" field. Use "<archive>.public-keys"
      instead.
    - The top-level "v1-public-keys" field. Use "public-keys" instead.

BREAKING CHANGE: New versions of chisel which includes this commit will
    no longer support the "chisel-v1" format in chisel-releases. Either
    update the "chisel.yaml" file in chisel-releases or use a lower
    version which does not have this commit.
  • Loading branch information
@rebornplusplus
rebornplusplus authored Jul 29, 2024
1 parent 504ad63 commit c7b49ba
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 99 deletions.
21 changes: 2 additions & 19 deletions internal/setup/setup.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,8 +328,6 @@ type yamlRelease struct {
Format string `yaml:"format"`
Archives map[string]yamlArchive `yaml:"archives"`
PubKeys map[string]yamlPubKey `yaml:"public-keys"`
// V1PubKeys is used for compatibility with format "chisel-v1".
V1PubKeys map[string]yamlPubKey `yaml:"v1-public-keys"`
}

type yamlArchive struct {
Expand All @@ -338,8 +336,6 @@ type yamlArchive struct {
Components []string `yaml:"components"`
Default bool `yaml:"default"`
PubKeys []string `yaml:"public-keys"`
// V1PubKeys is used for compatibility with format "chisel-v1".
V1PubKeys []string `yaml:"v1-public-keys"`
}

type yamlPackage struct {
Expand Down Expand Up @@ -426,18 +422,9 @@ func parseRelease(baseDir, filePath string, data []byte) (*Release, error) {
if err != nil {
return nil, fmt.Errorf("%s: cannot parse release definition: %v", fileName, err)
}
if yamlVar.Format != "chisel-v1" && yamlVar.Format != "v1" {
if yamlVar.Format != "v1" {
return nil, fmt.Errorf("%s: unknown format %q", fileName, yamlVar.Format)
}
// If format is "chisel-v1" we have to translate from the yaml key "v1-public-keys" to
// "public-keys".
if yamlVar.Format == "chisel-v1" {
yamlVar.PubKeys = yamlVar.V1PubKeys
for name, details := range yamlVar.Archives {
details.PubKeys = details.V1PubKeys
yamlVar.Archives[name] = details
}
}
if len(yamlVar.Archives) == 0 {
return nil, fmt.Errorf("%s: no archives defined", fileName)
}
Expand Down Expand Up @@ -478,11 +465,7 @@ func parseRelease(baseDir, filePath string, data []byte) (*Release, error) {
release.DefaultArchive = archiveName
}
if len(details.PubKeys) == 0 {
if yamlVar.Format == "chisel-v1" {
return nil, fmt.Errorf("%s: archive %q missing v1-public-keys field", fileName, archiveName)
} else {
return nil, fmt.Errorf("%s: archive %q missing public-keys field", fileName, archiveName)
}
return nil, fmt.Errorf("%s: archive %q missing public-keys field", fileName, archiveName)
}
var archiveKeys []*packet.PublicKey
for _, keyName := range details.PubKeys {
Expand Down
99 changes: 48 additions & 51 deletions internal/setup/setup_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package setup_test
import (
"os"
"path/filepath"
"strings"

"golang.org/x/crypto/openpgp/packet"
. "gopkg.in/check.v1"
Expand Down Expand Up @@ -39,7 +38,7 @@ var setupTests = []setupTest{{
summary: "Missing archives",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
`,
},
relerror: `chisel.yaml: no archives defined`,
Expand All @@ -55,14 +54,14 @@ var setupTests = []setupTest{{
summary: "Archive with multiple suites",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
ubuntu:
version: 22.04
components: [main, other]
suites: [jammy, jammy-security]
v1-public-keys: [test-key]
v1-public-keys:
public-keys: [test-key]
public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -768,20 +767,20 @@ var setupTests = []setupTest{{
summary: "Multiple archives",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
components: [main, universe]
suites: [jammy]
default: true
v1-public-keys: [test-key]
public-keys: [test-key]
bar:
version: 22.04
components: [universe]
suites: [jammy-updates]
v1-public-keys: [test-key]
v1-public-keys:
public-keys: [test-key]
public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -822,16 +821,16 @@ var setupTests = []setupTest{{
summary: "Extra fields in YAML are ignored (necessary for forward compatibility)",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
ubuntu:
version: 22.04
components: [main, other]
suites: [jammy, jammy-security]
v1-public-keys: [test-key]
public-keys: [test-key]
madeUpKey1: whatever
madeUpKey2: whatever
v1-public-keys:
public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -880,20 +879,20 @@ var setupTests = []setupTest{{
summary: "Archives with public keys",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
components: [main, universe]
suites: [jammy]
v1-public-keys: [extra-key]
public-keys: [extra-key]
default: true
bar:
version: 22.04
components: [universe]
suites: [jammy-updates]
v1-public-keys: [test-key, extra-key]
v1-public-keys:
public-keys: [test-key, extra-key]
public-keys:
extra-key:
id: ` + extraTestKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(extraTestKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -937,7 +936,7 @@ var setupTests = []setupTest{{
summary: "Archive without public keys",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
Expand All @@ -946,18 +945,18 @@ var setupTests = []setupTest{{
default: true
`,
},
relerror: `chisel.yaml: archive "foo" missing v1-public-keys field`,
relerror: `chisel.yaml: archive "foo" missing public-keys field`,
}, {
summary: "Unknown public key",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
components: [main, universe]
suites: [jammy]
v1-public-keys: [extra-key]
public-keys: [extra-key]
default: true
`,
"slices/mydir/mypkg.yaml": `
Expand All @@ -969,15 +968,15 @@ var setupTests = []setupTest{{
summary: "Invalid public key",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
components: [main, universe]
suites: [jammy]
v1-public-keys: [extra-key]
public-keys: [extra-key]
default: true
v1-public-keys:
public-keys:
extra-key:
id: foo
armor: |
Expand All @@ -997,15 +996,15 @@ var setupTests = []setupTest{{
summary: "Mismatched public key ID",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
components: [main, universe]
suites: [jammy]
v1-public-keys: [extra-key]
public-keys: [extra-key]
default: true
v1-public-keys:
public-keys:
extra-key:
id: ` + extraTestKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -1310,44 +1309,42 @@ var setupTests = []setupTest{{
`,
},
// TODO this should be an error because the content does not match.
}, {
summary: "chisel-v1 is deprecated",
input: map[string]string{
"chisel.yaml": `
format: chisel-v1
archives:
foo:
version: 22.04
components: [main, universe]
suites: [jammy]
v1-public-keys: [test-key]
default: true
v1-public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
`,
},
relerror: `chisel.yaml: unknown format "chisel-v1"`,
}}

var defaultChiselYaml = `
format: chisel-v1
format: v1
archives:
ubuntu:
version: 22.04
components: [main, universe]
v1-public-keys: [test-key]
v1-public-keys:
public-keys: [test-key]
public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
`

func (s *S) TestParseRelease(c *C) {
// Run tests for format chisel-v1.
runParseReleaseTests(c, setupTests)

// Run tests for format v1.
v1SetupTests := make([]setupTest, len(setupTests))
for i, t := range setupTests {
t.relerror = strings.Replace(t.relerror, "chisel-v1", "v1", -1)
t.relerror = strings.Replace(t.relerror, "v1-public-keys", "public-keys", -1)
m := map[string]string{}
for k, v := range t.input {
v = strings.Replace(v, "chisel-v1", "v1", -1)
v = strings.Replace(v, "v1-public-keys", "public-keys", -1)
m[k] = v
}
t.input = m
v1SetupTests[i] = t
}
runParseReleaseTests(c, v1SetupTests)
}

func runParseReleaseTests(c *C, tests []setupTest) {
for _, test := range tests {
for _, test := range setupTests {
c.Logf("Summary: %s", test.summary)

if _, ok := test.input["chisel.yaml"]; !ok {
Expand Down
37 changes: 8 additions & 29 deletions internal/slicer/slicer_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -759,18 +759,18 @@ var slicerTests = []slicerTest{{
slices: []setup.SliceKey{{"test-package", "myslice"}},
release: map[string]string{
"chisel.yaml": `
format: chisel-v1
format: v1
archives:
foo:
version: 22.04
components: [main, universe]
default: true
v1-public-keys: [test-key]
public-keys: [test-key]
bar:
version: 22.04
components: [main]
v1-public-keys: [test-key]
v1-public-keys:
public-keys: [test-key]
public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -1054,13 +1054,13 @@ var slicerTests = []slicerTest{{
}}

var defaultChiselYaml = `
format: chisel-v1
format: v1
archives:
ubuntu:
version: 22.04
components: [main, universe]
v1-public-keys: [test-key]
v1-public-keys:
public-keys: [test-key]
public-keys:
test-key:
id: ` + testKey.ID + `
armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + `
Expand Down Expand Up @@ -1088,28 +1088,7 @@ func (a *testArchive) Exists(pkg string) bool {
}

func (s *S) TestRun(c *C) {
// Run tests for format chisel-v1.
runSlicerTests(c, slicerTests)

// Run tests for format v1.
v1SlicerTests := make([]slicerTest, len(slicerTests))
for i, t := range slicerTests {
t.error = strings.Replace(t.error, "chisel-v1", "v1", -1)
t.error = strings.Replace(t.error, "v1-public-keys", "public-keys", -1)
m := map[string]string{}
for k, v := range t.release {
v = strings.Replace(v, "chisel-v1", "v1", -1)
v = strings.Replace(v, "v1-public-keys", "public-keys", -1)
m[k] = v
}
t.release = m
v1SlicerTests[i] = t
}
runSlicerTests(c, v1SlicerTests)
}

func runSlicerTests(c *C, tests []slicerTest) {
for _, test := range tests {
for _, test := range slicerTests {
for _, slices := range testutil.Permutations(test.slices) {
c.Logf("Summary: %s", test.summary)

Expand Down

0 comments on commit c7b49ba

Please sign in to comment.