Skip to content

Commit

Permalink
Rename final_name -> name in config/final.yml
Browse files Browse the repository at this point in the history
The field is already in a file named "final" and we no longer need
to differentiate from a dev name.
  • Loading branch information
dpb587 committed Nov 14, 2016
1 parent acb0f0e commit 6668d19
Show file tree
Hide file tree
Showing 8 changed files with 93 additions and 93 deletions.
2 changes: 1 addition & 1 deletion acceptance/assets/sample-release/config/final.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
---
final_name: sample-release
name: sample-release
16 changes: 8 additions & 8 deletions releasedir/fs_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
/*
# final.yml
---
final_name: cf
name: cf
min_cli_version: 1.5.0.pre.1001
blobstore:
provider: s3
Expand All @@ -29,7 +29,7 @@ type FSConfig struct {
}

type fsConfigPublicSchema struct {
FinalName string `yaml:"final_name"`
Name string `yaml:"name"`
Blobstore fsConfigSchema_Blobstore `yaml:"blobstore,omitempty"`
}

Expand All @@ -46,27 +46,27 @@ func NewFSConfig(publicPath, privatePath string, fs boshsys.FileSystem) FSConfig
return FSConfig{publicPath: publicPath, privatePath: privatePath, fs: fs}
}

func (c FSConfig) FinalName() (string, error) {
func (c FSConfig) Name() (string, error) {
publicSchema, _, err := c.read()
if err != nil {
return "", err
}

if len(publicSchema.FinalName) == 0 {
if len(publicSchema.Name) == 0 {
return "", bosherr.Errorf(
"Expected non-empty 'final_name' in config '%s'", c.publicPath)
"Expected non-empty 'name' in config '%s'", c.publicPath)
}

return publicSchema.FinalName, nil
return publicSchema.Name, nil
}

func (c FSConfig) SaveFinalName(name string) error {
func (c FSConfig) SaveName(name string) error {
publicSchema, _, err := c.read()
if err != nil {
return err
}

publicSchema.FinalName = name
publicSchema.Name = name

bytes, err := yaml.Marshal(publicSchema)
if err != nil {
Expand Down
46 changes: 23 additions & 23 deletions releasedir/fs_config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,36 @@ var _ = Describe("FSConfig", func() {
config = NewFSConfig("/dir/public.yml", "/dir/private.yml", fs)
})

Describe("FinalName", func() {
Describe("Name", func() {
It("returns final name from public config", func() {
fs.WriteFileString("/dir/public.yml", "final_name: name")
fs.WriteFileString("/dir/public.yml", "name: name")

name, err := config.FinalName()
name, err := config.Name()
Expect(err).ToNot(HaveOccurred())
Expect(name).To(Equal("name"))
})

It("returns error if name is empty", func() {
fs.WriteFileString("/dir/public.yml", "")

_, err := config.FinalName()
_, err := config.Name()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("Expected non-empty 'final_name' in config '/dir/public.yml'"))
Expect(err.Error()).To(Equal("Expected non-empty 'name' in config '/dir/public.yml'"))
})

It("returns error if cannot read public config", func() {
fs.WriteFileString("/dir/public.yml", "-")
fs.RegisterReadFileError("/dir/public.yml", errors.New("fake-err"))

_, err := config.FinalName()
_, err := config.Name()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-err"))
})

It("returns error if cannot unmarshal public config", func() {
fs.WriteFileString("/dir/public.yml", "-")

_, err := config.FinalName()
_, err := config.Name()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("line 1"))
})
Expand All @@ -59,15 +59,15 @@ var _ = Describe("FSConfig", func() {
fs.WriteFileString("/dir/private.yml", "-")
fs.RegisterReadFileError("/dir/private.yml", errors.New("fake-err"))

_, err := config.FinalName()
_, err := config.Name()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-err"))
})

It("returns error if cannot unmarshal private config", func() {
fs.WriteFileString("/dir/private.yml", "-")

_, err := config.FinalName()
_, err := config.Name()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("line 1"))
})
Expand Down Expand Up @@ -149,46 +149,46 @@ var _ = Describe("FSConfig", func() {
})
})

Describe("SaveFinalName", func() {
Describe("SaveName", func() {
It("writes new config with name if config does not exist", func() {
err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).ToNot(HaveOccurred())

Expect(fs.ReadFileString("/dir/public.yml")).To(Equal("final_name: new-name\n"))
Expect(fs.ReadFileString("/dir/public.yml")).To(Equal("name: new-name\n"))
})

It("adds name to public config keeping other entries", func() {
fs.WriteFileString("/dir/public.yml", "final_name: name")
fs.WriteFileString("/dir/public.yml", "name: name")

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).ToNot(HaveOccurred())

Expect(fs.ReadFileString("/dir/public.yml")).To(Equal("final_name: new-name\n"))
Expect(fs.ReadFileString("/dir/public.yml")).To(Equal("name: new-name\n"))
})

It("overwrites existing name in public config keeping other entries", func() {
fs.WriteFileString("/dir/public.yml", "final_name: name\nblobstore: {provider: s3}")
fs.WriteFileString("/dir/public.yml", "name: name\nblobstore: {provider: s3}")

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).ToNot(HaveOccurred())

Expect(fs.ReadFileString("/dir/public.yml")).To(Equal(
"final_name: new-name\nblobstore:\n provider: s3\n"))
"name: new-name\nblobstore:\n provider: s3\n"))
})

It("returns error if cannot read public config", func() {
fs.WriteFileString("/dir/public.yml", "-")
fs.RegisterReadFileError("/dir/public.yml", errors.New("fake-err"))

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-err"))
})

It("returns error if cannot unmarshal public config", func() {
fs.WriteFileString("/dir/public.yml", "-")

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("line 1"))
})
Expand All @@ -197,23 +197,23 @@ var _ = Describe("FSConfig", func() {
fs.WriteFileString("/dir/private.yml", "-")
fs.RegisterReadFileError("/dir/private.yml", errors.New("fake-err"))

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-err"))
})

It("returns error if cannot unmarshal private config", func() {
fs.WriteFileString("/dir/private.yml", "-")

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("line 1"))
})

It("returns error if cannot write public config", func() {
fs.WriteFileError = errors.New("fake-err")

err := config.SaveFinalName("new-name")
err := config.SaveName("new-name")
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-err"))
})
Expand Down
4 changes: 2 additions & 2 deletions releasedir/fs_generator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ var _ = Describe("FSGenerator", func() {

Describe("GenerateJob", func() {
It("makes job directory", func() {
fs.WriteFileString("/dir/public.yml", "final_name: name")
fs.WriteFileString("/dir/public.yml", "name: name")

err := gen.GenerateJob("job1")
Expect(err).ToNot(HaveOccurred())
Expand Down Expand Up @@ -63,7 +63,7 @@ properties: {}

Describe("GeneratePackage", func() {
It("makes package directory", func() {
fs.WriteFileString("/dir/public.yml", "final_name: name")
fs.WriteFileString("/dir/public.yml", "name: name")

err := gen.GeneratePackage("pkg1")
Expect(err).ToNot(HaveOccurred())
Expand Down
6 changes: 3 additions & 3 deletions releasedir/fs_release_dir.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ func (d FSReleaseDir) Init(git bool) error {
}
}

finalName := strings.TrimSuffix(gopath.Base(d.dirPath), "-release")
name := strings.TrimSuffix(gopath.Base(d.dirPath), "-release")

err := d.config.SaveFinalName(finalName)
err := d.config.SaveName(name)
if err != nil {
return err
}
Expand Down Expand Up @@ -124,7 +124,7 @@ func (d FSReleaseDir) Reset() error {
}

func (d FSReleaseDir) DefaultName() (string, error) {
return d.config.FinalName()
return d.config.Name()
}

func (d FSReleaseDir) NextFinalVersion(name string) (semver.Version, error) {
Expand Down
16 changes: 8 additions & 8 deletions releasedir/fs_release_dir_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ var _ = Describe("FSGenerator", func() {
err := releaseDir.Init(true)
Expect(err).ToNot(HaveOccurred())

Expect(config.SaveFinalNameCallCount()).To(Equal(1))
Expect(config.SaveFinalNameArgsForCall(0)).To(Equal("dir"))
Expect(config.SaveNameCallCount()).To(Equal(1))
Expect(config.SaveNameArgsForCall(0)).To(Equal("dir"))
})

It("saves release name to directory base name stripping '-release' suffix from the name", func() {
Expand All @@ -88,12 +88,12 @@ var _ = Describe("FSGenerator", func() {
err := releaseDir.Init(true)
Expect(err).ToNot(HaveOccurred())

Expect(config.SaveFinalNameCallCount()).To(Equal(1))
Expect(config.SaveFinalNameArgsForCall(0)).To(Equal("dir"))
Expect(config.SaveNameCallCount()).To(Equal(1))
Expect(config.SaveNameArgsForCall(0)).To(Equal("dir"))
})

It("returns error if saving final name fails", func() {
config.SaveFinalNameReturns(errors.New("fake-err"))
config.SaveNameReturns(errors.New("fake-err"))

err := releaseDir.Init(true)
Expect(err).To(HaveOccurred())
Expand Down Expand Up @@ -185,7 +185,7 @@ var _ = Describe("FSGenerator", func() {

Describe("DefaultName", func() {
It("delegates to config", func() {
config.FinalNameReturns("name", errors.New("fake-err"))
config.NameReturns("name", errors.New("fake-err"))

name, err := releaseDir.DefaultName()
Expect(name).To(Equal("name"))
Expand Down Expand Up @@ -349,7 +349,7 @@ var _ = Describe("FSGenerator", func() {
)

BeforeEach(func() {
config.FinalNameReturns("rel1", nil)
config.NameReturns("rel1", nil)

expectedRelease = &fakerel.FakeRelease{
NameStub: func() string { return "rel1" },
Expand Down Expand Up @@ -483,7 +483,7 @@ var _ = Describe("FSGenerator", func() {
})

It("retuns error if cannot determine final name", func() {
config.FinalNameReturns("", errors.New("fake-err"))
config.NameReturns("", errors.New("fake-err"))

_, err := releaseDir.LastRelease()
Expect(err).To(HaveOccurred())
Expand Down
4 changes: 2 additions & 2 deletions releasedir/interfaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ type ReleaseDir interface {
//go:generate counterfeiter . Config

type Config interface {
FinalName() (string, error)
SaveFinalName(string) error
Name() (string, error)
SaveName(string) error

Blobstore() (string, map[string]interface{}, error)
}
Expand Down
Loading

0 comments on commit 6668d19

Please sign in to comment.