refactor: rename public BOSH Release identifiers

add Tarball and make it clear we are working with BOSH releases

internal/acceptance/workflows/scenario/step_funcs_tile_source_code.go

@@ -50,7 +50,7 @@ func theLockSpecifiesVersionForRelease(ctx context.Context, releaseVersion, rele
  if err != nil {
  return err
  }
- releaseLock, err := lock.FindReleaseWithName(releaseName)
+ releaseLock, err := lock.FindBOSHReleaseWithName(releaseName)
  if err != nil {
  return err
  }
@@ -225,7 +225,7 @@ func theKilnfileVersionForReleaseIs(ctx context.Context, releaseName, releaseVer
  if err != nil {
  return err
  }
- releaseLock, err := kf.ComponentSpec(releaseName)
+ releaseLock, err := kf.BOSHReleaseTarballSpecification(releaseName)
  if err != nil {
  return err
  }

internal/commands/find_release_version.go

@@ -44,7 +44,7 @@ func (cmd *FindReleaseVersion) Execute(args []string) error {
  }
  releaseSource := cmd.mrsProvider(kilnfile, false)
 
- spec, err := kilnfile.ComponentSpec(cmd.Options.Release)
+ spec, err := kilnfile.BOSHReleaseTarballSpecification(cmd.Options.Release)
  if err != nil {
  return err
  }

internal/commands/glaze.go

@@ -47,7 +47,7 @@ func (cmd *Glaze) Usage() jhanda.Usage {
 func pinVersions(kf cargo.Kilnfile, kl cargo.KilnfileLock) (cargo.Kilnfile, error) {
  kf.Stemcell.Version = kl.Stemcell.Version
  for releaseIndex, release := range kf.Releases {
- l, err := kl.FindReleaseWithName(release.Name)
+ l, err := kl.FindBOSHReleaseWithName(release.Name)
  if err != nil {
  return cargo.Kilnfile{}, fmt.Errorf("release with name %q not found in Kilnfile.lock: %w", release.Name, err)
  }

internal/commands/update_release.go

@@ -46,14 +46,14 @@ func (u UpdateRelease) Execute(args []string) error {
  return fmt.Errorf("error loading Kilnfiles: %w", err)
  }
 
- releaseLock, err := kilnfileLock.FindReleaseWithName(u.Options.Name)
+ releaseLock, err := kilnfileLock.FindBOSHReleaseWithName(u.Options.Name)
  if err != nil {
  return fmt.Errorf(
  "no release named %q exists in your Kilnfile.lock - try removing the -release, -boshrelease, or -bosh-release suffix if present",
  u.Options.Name,
  )
  }
- releaseSpec, err := kilnfile.ComponentSpec(u.Options.Name)
+ releaseSpec, err := kilnfile.BOSHReleaseTarballSpecification(u.Options.Name)
  if err != nil {
  return err
  }
@@ -127,7 +127,7 @@ func (u UpdateRelease) Execute(args []string) error {
  releaseLock.RemoteSource = newSourceID
  releaseLock.RemotePath = newRemotePath
 
- _ = kilnfileLock.UpdateReleaseLockWithName(u.Options.Name, releaseLock)
+ _ = kilnfileLock.UpdateBOSHReleaseTarballLockWithName(u.Options.Name, releaseLock)
 
  err = u.Options.Standard.SaveKilnfileLock(u.filesystem, kilnfileLock)
  if err != nil {

internal/commands/update_stemcell.go

@@ -70,7 +70,7 @@ func (update UpdateStemcell) Execute(args []string) error {
  for i, rel := range kilnfileLock.Releases {
  update.Logger.Printf("Updating release %q with stemcell %s %s...", rel.Name, kilnfileLock.Stemcell.OS, trimmedInputVersion)
 
- spec, err := kilnfile.ComponentSpec(rel.Name)
+ spec, err := kilnfile.BOSHReleaseTarballSpecification(rel.Name)
  if err != nil {
  return err
  }

internal/component/release_source.go

@@ -73,16 +73,16 @@ const (
 
 // TODO: use the constants from "cargo" everywhere
 const (
- ReleaseSourceTypeBOSHIO = cargo.ReleaseSourceTypeBOSHIO
- ReleaseSourceTypeS3 = cargo.ReleaseSourceTypeS3
- ReleaseSourceTypeGithub = cargo.ReleaseSourceTypeGithub
- ReleaseSourceTypeArtifactory = cargo.ReleaseSourceTypeArtifactory
+ ReleaseSourceTypeBOSHIO = cargo.BOSHReleaseTarballSourceTypeBOSHIO
+ ReleaseSourceTypeS3 = cargo.BOSHReleaseTarballSourceTypeS3
+ ReleaseSourceTypeGithub = cargo.BOSHReleaseTarballSourceTypeGithub
+ ReleaseSourceTypeArtifactory = cargo.BOSHReleaseTarballSourceTypeArtifactory
 )
 
 // ReleaseSourceFactory returns a configured ReleaseSource based on the Type field on the
 // cargo.ReleaseSourceConfig structure.
 func ReleaseSourceFactory(releaseConfig cargo.ReleaseSourceConfig, outLogger *log.Logger) ReleaseSource {
- releaseConfig.ID = cargo.ReleaseSourceID(releaseConfig)
+ releaseConfig.ID = cargo.BOSHReleaseTarballSourceID(releaseConfig)
  switch releaseConfig.Type {
  case ReleaseSourceTypeBOSHIO:
  return NewBOSHIOReleaseSource(releaseConfig, "", outLogger)

pkg/cargo/bump.go

@@ -193,7 +193,7 @@ func fetchReleasesFromRepo(ctx context.Context, repoService RepositoryReleaseLis
 }
 
 func fetchReleasesForBump(ctx context.Context, repoService RepositoryReleaseLister, kf Kilnfile, bump Bump) Bump {
- spec, err := kf.ComponentSpec(bump.Name)
+ spec, err := kf.BOSHReleaseTarballSpecification(bump.Name)
  if err != nil {
  return bump
  }

pkg/cargo/kilnfile.go

@@ -18,7 +18,7 @@ type Kilnfile struct {
  Stemcell Stemcell `yaml:"stemcell_criteria,omitempty"`
 }
 
-func (kf Kilnfile) ComponentSpec(name string) (BOSHReleaseTarballSpecification, error) {
+func (kf Kilnfile) BOSHReleaseTarballSpecification(name string) (BOSHReleaseTarballSpecification, error) {
  for _, s := range kf.Releases {
  if s.Name == name {
  return s, nil
@@ -32,7 +32,7 @@ type KilnfileLock struct {
  Stemcell Stemcell `yaml:"stemcell_criteria"`
 }
 
-func (k KilnfileLock) FindReleaseWithName(name string) (BOSHReleaseTarballLock, error) {
+func (k KilnfileLock) FindBOSHReleaseWithName(name string) (BOSHReleaseTarballLock, error) {
  for _, r := range k.Releases {
  if r.Name == name {
  return r, nil
@@ -41,7 +41,7 @@ func (k KilnfileLock) FindReleaseWithName(name string) (BOSHReleaseTarballLock,
  return BOSHReleaseTarballLock{}, errors.New("not found")
 }
 
-func (k KilnfileLock) UpdateReleaseLockWithName(name string, lock BOSHReleaseTarballLock) error {
+func (k KilnfileLock) UpdateBOSHReleaseTarballLockWithName(name string, lock BOSHReleaseTarballLock) error {
  for i, r := range k.Releases {
  if r.Name == name {
  k.Releases[i] = lock

pkg/cargo/kilnfile_test.go

@@ -30,7 +30,7 @@ remote_path: fake/path/to/fake-component-name
  damnit.Expect(string(cl)).To(Equal(validComponentLockYaml))
 }
 
-func TestKilnfileLock_UpdateReleaseLockWithName(t *testing.T) {
+func TestKilnfileLock_UpdateBOSHReleaseTarballLockWithName(t *testing.T) {
  type args struct {
  name string
  lock BOSHReleaseTarballLock
@@ -63,7 +63,7 @@ func TestKilnfileLock_UpdateReleaseLockWithName(t *testing.T) {
  }
  for _, tt := range tests {
  t.Run(tt.name, func(t *testing.T) {
- if err := tt.KilnfileLock.UpdateReleaseLockWithName(tt.args.name, tt.args.lock); tt.wantErr {
+ if err := tt.KilnfileLock.UpdateBOSHReleaseTarballLockWithName(tt.args.name, tt.args.lock); tt.wantErr {
  assert.Error(t, err)
  } else {
  assert.NoError(t, err)

pkg/cargo/release_source.go

@@ -1,36 +1,36 @@
 package cargo
 
 const (
- // ReleaseSourceTypeBOSHIO is the value of the Type field on cargo.ReleaseSourceConfig
+ // BOSHReleaseTarballSourceTypeBOSHIO is the value of the Type field on cargo.ReleaseSourceConfig
  // for fetching https://bosh.io releases.
- ReleaseSourceTypeBOSHIO = "bosh.io"
+ BOSHReleaseTarballSourceTypeBOSHIO = "bosh.io"
 
- // ReleaseSourceTypeS3 is the value for the Type field on cargo.ReleaseSourceConfig
+ // BOSHReleaseTarballSourceTypeS3 is the value for the Type field on cargo.ReleaseSourceConfig
  // for releases stored on
- ReleaseSourceTypeS3 = "s3"
+ BOSHReleaseTarballSourceTypeS3 = "s3"
 
- // ReleaseSourceTypeGithub is the value for the Type field on cargo.ReleaseSourceConfig
+ // BOSHReleaseTarballSourceTypeGithub is the value for the Type field on cargo.ReleaseSourceConfig
  // for releases stored on GitHub.
- ReleaseSourceTypeGithub = "github"
+ BOSHReleaseTarballSourceTypeGithub = "github"
 
- // ReleaseSourceTypeArtifactory is the value for the Type field on cargo.ReleaseSourceConfig
+ // BOSHReleaseTarballSourceTypeArtifactory is the value for the Type field on cargo.ReleaseSourceConfig
  // for releases stored on Artifactory.
- ReleaseSourceTypeArtifactory = "artifactory"
+ BOSHReleaseTarballSourceTypeArtifactory = "artifactory"
 )
 
-func ReleaseSourceID(releaseConfig ReleaseSourceConfig) string {
+func BOSHReleaseTarballSourceID(releaseConfig ReleaseSourceConfig) string {
  if releaseConfig.ID != "" {
  return releaseConfig.ID
  }
  switch releaseConfig.Type {
- case ReleaseSourceTypeBOSHIO:
- return ReleaseSourceTypeBOSHIO
- case ReleaseSourceTypeS3:
+ case BOSHReleaseTarballSourceTypeBOSHIO:
+ return BOSHReleaseTarballSourceTypeBOSHIO
+ case BOSHReleaseTarballSourceTypeS3:
  return releaseConfig.Bucket
- case ReleaseSourceTypeGithub:
+ case BOSHReleaseTarballSourceTypeGithub:
  return releaseConfig.Org
- case ReleaseSourceTypeArtifactory:
- return ReleaseSourceTypeArtifactory
+ case BOSHReleaseTarballSourceTypeArtifactory:
+ return BOSHReleaseTarballSourceTypeArtifactory
  default:
  return ""
  }

pkg/cargo/release_source_test.go

@@ -15,18 +15,18 @@ func TestReleaseSourceID(t *testing.T) {
  {Name: "zero value", ExpectedID: "", Configuration: ReleaseSourceConfig{}},
  {Name: "unknown type", ExpectedID: "", Configuration: ReleaseSourceConfig{Type: "banana"}},
 
- {Name: ReleaseSourceTypeArtifactory + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: ReleaseSourceTypeArtifactory}},
- {Name: ReleaseSourceTypeBOSHIO + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: ReleaseSourceTypeBOSHIO}},
- {Name: ReleaseSourceTypeGithub + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: ReleaseSourceTypeGithub}},
- {Name: ReleaseSourceTypeS3 + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: ReleaseSourceTypeS3}},
+ {Name: BOSHReleaseTarballSourceTypeArtifactory + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: BOSHReleaseTarballSourceTypeArtifactory}},
+ {Name: BOSHReleaseTarballSourceTypeBOSHIO + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: BOSHReleaseTarballSourceTypeBOSHIO}},
+ {Name: BOSHReleaseTarballSourceTypeGithub + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: BOSHReleaseTarballSourceTypeGithub}},
+ {Name: BOSHReleaseTarballSourceTypeS3 + " with ID set", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "identifier", Type: BOSHReleaseTarballSourceTypeS3}},
 
- {Name: ReleaseSourceTypeArtifactory + " default", ExpectedID: ReleaseSourceTypeArtifactory, Configuration: ReleaseSourceConfig{ID: "", Type: ReleaseSourceTypeArtifactory}},
- {Name: ReleaseSourceTypeBOSHIO + " default", ExpectedID: ReleaseSourceTypeBOSHIO, Configuration: ReleaseSourceConfig{ID: "", Type: ReleaseSourceTypeBOSHIO}},
- {Name: ReleaseSourceTypeGithub + " default", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "", Type: ReleaseSourceTypeGithub, Org: "identifier"}},
- {Name: ReleaseSourceTypeS3 + " default", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "", Type: ReleaseSourceTypeS3, Bucket: "identifier"}},
+ {Name: BOSHReleaseTarballSourceTypeArtifactory + " default", ExpectedID: BOSHReleaseTarballSourceTypeArtifactory, Configuration: ReleaseSourceConfig{ID: "", Type: BOSHReleaseTarballSourceTypeArtifactory}},
+ {Name: BOSHReleaseTarballSourceTypeBOSHIO + " default", ExpectedID: BOSHReleaseTarballSourceTypeBOSHIO, Configuration: ReleaseSourceConfig{ID: "", Type: BOSHReleaseTarballSourceTypeBOSHIO}},
+ {Name: BOSHReleaseTarballSourceTypeGithub + " default", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "", Type: BOSHReleaseTarballSourceTypeGithub, Org: "identifier"}},
+ {Name: BOSHReleaseTarballSourceTypeS3 + " default", ExpectedID: "identifier", Configuration: ReleaseSourceConfig{ID: "", Type: BOSHReleaseTarballSourceTypeS3, Bucket: "identifier"}},
  } {
  t.Run(tt.Name, func(t *testing.T) {
- assert.Equal(t, tt.ExpectedID, ReleaseSourceID(tt.Configuration))
+ assert.Equal(t, tt.ExpectedID, BOSHReleaseTarballSourceID(tt.Configuration))
  })
  }
 }

pkg/cargo/validate.go

@@ -16,7 +16,7 @@ func Validate(spec Kilnfile, lock KilnfileLock) []error {
  continue
  }
 
- componentLock, err := lock.FindReleaseWithName(componentSpec.Name)
+ componentLock, err := lock.FindBOSHReleaseWithName(componentSpec.Name)
  if err != nil {
  result = append(result,
  fmt.Errorf("component spec for release %q not found in lock", componentSpec.Name))
@@ -41,7 +41,7 @@ func ensureRemoteSourceExistsForEachReleaseLock(spec Kilnfile, lock KilnfileLock
  var result []error
  for _, release := range lock.Releases {
  if releaseSourceIndex := slices.IndexFunc(spec.ReleaseSources, func(config ReleaseSourceConfig) bool {
- return ReleaseSourceID(config) == release.RemoteSource
+ return BOSHReleaseTarballSourceID(config) == release.RemoteSource
  }); releaseSourceIndex < 0 {
  result = append(result,
  fmt.Errorf("release source %q for release lock %q not found in Kilnfile", release.RemoteSource, release.Name))

pkg/cargo/validate_test.go

@@ -136,14 +136,14 @@ func TestValidate_release_sources(t *testing.T) {
  please := NewWithT(t)
  results := Validate(Kilnfile{
  ReleaseSources: []ReleaseSourceConfig{
- {Type: ReleaseSourceTypeBOSHIO},
+ {Type: BOSHReleaseTarballSourceTypeBOSHIO},
  },
  Releases: []BOSHReleaseTarballSpecification{
  {Name: "orange"},
  },
  }, KilnfileLock{
  Releases: []BOSHReleaseTarballLock{
- {Name: "orange", Version: "1.2.3", RemoteSource: ReleaseSourceTypeBOSHIO},
+ {Name: "orange", Version: "1.2.3", RemoteSource: BOSHReleaseTarballSourceTypeBOSHIO},
  },
  })
  please.Expect(results).To(BeEmpty())
@@ -152,14 +152,14 @@ func TestValidate_release_sources(t *testing.T) {
  please := NewWithT(t)
  results := Validate(Kilnfile{
  ReleaseSources: []ReleaseSourceConfig{
- {ID: "open source", Type: ReleaseSourceTypeBOSHIO},
+ {ID: "open source", Type: BOSHReleaseTarballSourceTypeBOSHIO},
  },
  Releases: []BOSHReleaseTarballSpecification{
  {Name: "orange"},
  },
  }, KilnfileLock{
  Releases: []BOSHReleaseTarballLock{
- {Name: "orange", Version: "1.2.3", RemoteSource: ReleaseSourceTypeBOSHIO},
+ {Name: "orange", Version: "1.2.3", RemoteSource: BOSHReleaseTarballSourceTypeBOSHIO},
  },
  })
  please.Expect(results).To(HaveLen(1))
@@ -168,7 +168,7 @@ func TestValidate_release_sources(t *testing.T) {
  please := NewWithT(t)
  results := Validate(Kilnfile{
  ReleaseSources: []ReleaseSourceConfig{
- {Org: "crhntr", Type: ReleaseSourceTypeGithub},
+ {Org: "crhntr", Type: BOSHReleaseTarballSourceTypeGithub},
  },
  Releases: []BOSHReleaseTarballSpecification{
  {Name: "hello-tile", GitHubRepository: "https://github.com/crhntr/hello-tile"},

pkg/notes/notes_data.go

@@ -526,7 +526,7 @@ func setEmptyComponentGitHubRepositoryFromOtherKilnfile(k1, k2 cargo.Kilnfile) c
  if r.GitHubRepository != "" {
  continue
  }
- spec, err := k2.ComponentSpec(r.Name)
+ spec, err := k2.BOSHReleaseTarballSpecification(r.Name)
  if err != nil {
  continue
  }