Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: kiln publish attaches all matching license files to release #383

Merged
merged 3 commits into from
May 4, 2023
Merged

feat: kiln publish attaches all matching license files to release #383

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f60604
feat: kiln publish attaches all matching license files to release
May 1, 2023
2d76b42
refactor: minor logic simplification to license handling and testing
May 3, 2023
e81d39d
refactor: replace empty slices with nil - the preferred idiom
May 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 37 additions & 18 deletions internal/commands/publish.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,12 @@ func (p Publish) updateReleaseOnPivnet(kilnfile cargo.Kilnfile, buildVersion *se
return err
}

licenseFileName, err := p.attachLicenseFile(kilnfile.Slug, release.ID, versionToPublish)
licenseFileNames, err := p.attachLicenseFiles(kilnfile.Slug, release.ID, versionToPublish)
if err != nil {
if len(licenseFileNames) > 0 {
p.ErrLogger.Println("Attached the following license files before failure:")
p.printLicenseFiles(licenseFileNames, p.ErrLogger)
}
return err
}

Expand Down Expand Up @@ -257,7 +261,7 @@ func (p Publish) updateReleaseOnPivnet(kilnfile cargo.Kilnfile, buildVersion *se
}

releaseDate := p.Now().Format(publishDateFormat)
updatedRelease, err := p.updateRelease(release, kilnfile.Slug, versionToPublish.String(), releaseType, releaseDate, endOfSupportDate, availability, licenseFileName)
updatedRelease, err := p.updateRelease(release, kilnfile.Slug, versionToPublish.String(), releaseType, releaseDate, endOfSupportDate, availability, licenseFileNames)
if err != nil {
return err
}
Expand Down Expand Up @@ -293,7 +297,13 @@ func (p Publish) eogsDate(rv *releaseVersion, releases releaseSet) (string, erro
return "", nil
}

func (p Publish) updateRelease(release pivnet.Release, slug, version string, releaseType pivnet.ReleaseType, releaseDate, endOfSupportDate, availability, licenseFileName string) (pivnet.Release, error) {
func (p Publish) printLicenseFiles(licenseFileNames []string, logger *log.Logger) {
for _, licenseFileName := range licenseFileNames {
logger.Printf(" License file: %s\n", licenseFileName)
}
}

func (p Publish) updateRelease(release pivnet.Release, slug, version string, releaseType pivnet.ReleaseType, releaseDate, endOfSupportDate, availability string, licenseFileNames []string) (pivnet.Release, error) {
p.OutLogger.Println("Updating product record on PivNet...")
p.OutLogger.Printf(" Version: %s\n", version)
p.OutLogger.Printf(" Release date: %s\n", releaseDate)
Expand All @@ -302,8 +312,8 @@ func (p Publish) updateRelease(release pivnet.Release, slug, version string, rel
p.OutLogger.Printf(" EOGS date: %s\n", endOfSupportDate)
}
p.OutLogger.Printf(" Availability: %s\n", availability)
if licenseFileName != "" {
p.OutLogger.Printf(" License file: %s\n", licenseFileName)
if len(licenseFileNames) > 0 {
p.printLicenseFiles(licenseFileNames, p.OutLogger)
} else {
p.OutLogger.Printf(" License file: None, pre-GA release")
}
Expand Down Expand Up @@ -374,35 +384,44 @@ func endOfSupportFor(publishDate time.Time) string {
return endOfNinthMonth.Format(publishDateFormat)
}

func (p Publish) attachLicenseFile(slug string, releaseID int, version *releaseVersion) (string, error) {
func (p Publish) attachLicenseFiles(slug string, releaseID int, version *releaseVersion) ([]string, error) {
var attachedLicenseFileNames []string

if version.IsGA() {
productFiles, err := p.PivnetProductFilesService.List(slug)
if err != nil {
return "", err
return attachedLicenseFileNames, err
}

productFile, found := findMatchingOSL(productFiles, version)
licenseFiles, found := findMatchingLicenseFiles(productFiles, version)
if !found {
return "", errors.New("required license file doesn't exist on Pivnet")
return attachedLicenseFileNames, errors.New("required license file doesn't exist on Pivnet")
}

err = p.PivnetProductFilesService.AddToRelease(slug, releaseID, productFile.ID)
if err == nil {
return productFile.Name, nil
} else {
return "", err
for _, licenseFile := range licenseFiles {
err = p.PivnetProductFilesService.AddToRelease(slug, releaseID, licenseFile.ID)

if err == nil {
attachedLicenseFileNames = append(attachedLicenseFileNames, licenseFile.Name)
crhntr marked this conversation as resolved.
Show resolved Hide resolved
} else {
return attachedLicenseFileNames, err
}
}
}
return "", nil
return attachedLicenseFileNames, nil
}

func findMatchingOSL(productFiles []pivnet.ProductFile, version *releaseVersion) (pivnet.ProductFile, bool) {
func findMatchingLicenseFiles(productFiles []pivnet.ProductFile, version *releaseVersion) ([]pivnet.ProductFile, bool) {
var matchingLicenseFiles []pivnet.ProductFile
foundLicenses := false
crhntr marked this conversation as resolved.
Show resolved Hide resolved

for _, file := range productFiles {
if file.FileType == oslFileType && file.FileVersion == version.MajorAndMinor() {
return file, true
matchingLicenseFiles = append(matchingLicenseFiles, file)
foundLicenses = true
}
}
return pivnet.ProductFile{}, false
return matchingLicenseFiles, foundLicenses
}

func (p Publish) determineVersion(releases releaseSet, version *releaseVersion) (*releaseVersion, error) {
Expand Down
160 changes: 129 additions & 31 deletions internal/commands/publish_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,11 @@ pre_ga_user_groups:

Context("during the ga window", func() {
const (
version20FileID = 42
version21FileID = 43
version20OslFileID = 42
version21OslFileID = 43
version21OsmPartOneFileId = 44
version21OsmPartTwoFileId = 45
version20OsmFileId = 46
)
var (
args []string
Expand Down Expand Up @@ -423,17 +426,35 @@ pre_ga_user_groups:
FileType: "Snake Oil",
},
{
ID: version21FileID,
ID: version21OslFileID,
Name: "PCF Pivotal Application Service v2.1 OSL",
FileVersion: "2.1",
FileType: "Open Source License",
},
{
ID: version20FileID,
ID: version20OslFileID,
Name: "PCF Pivotal Application Service v2.0 OSL",
FileVersion: "2.0",
FileType: "Open Source License",
},
{
ID: version21OsmPartOneFileId,
Name: "PCF Pivotal Application Service v2.1 OSM Part 1/2",
FileVersion: "2.1",
FileType: "Open Source License",
},
{
ID: version21OsmPartTwoFileId,
Name: "PCF Pivotal Application Service v2.1 OSM Part 2/2",
FileVersion: "2.1",
FileType: "Open Source License",
},
{
ID: version20OsmFileId,
Name: "PCF Pivotal Application Service v2.0 OSM",
FileVersion: "2.0",
FileType: "Open Source License",
},
},
nil,
)
Expand Down Expand Up @@ -468,17 +489,25 @@ pre_ga_user_groups:
Expect(outLoggerBuffer.String()).To(ContainSubstring("Availability: All Users"))
})

It("adds the appropriate OSL file", func() {
It("attaches all license files to the release that match its major and minor", func() {
expectedProductFileIds := []int{version20OslFileID, version20OsmFileId}

err := publish.Execute(args)
Expect(err).NotTo(HaveOccurred())

Expect(pfs.AddToReleaseCallCount()).To(Equal(1))
productSlug, productReleaseID, fileID := pfs.AddToReleaseArgsForCall(0)
Expect(productSlug).To(Equal(slug))
Expect(productReleaseID).To(Equal(releaseID))
Expect(fileID).To(Equal(version20FileID))
Expect(pfs.AddToReleaseCallCount()).To(Equal(2))

var productFileIds []int
for i := 0; i <= 1; i++ {
productSlug, productReleaseID, fileID := pfs.AddToReleaseArgsForCall(i)
Expect(productSlug).To(Equal(slug))
Expect(productReleaseID).To(Equal(releaseID))
productFileIds = append(productFileIds, fileID)
}
Expect(productFileIds).To(Equal(expectedProductFileIds))

Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.0 OSL"))
Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.0 OSM"))
})

Context("when the --security-fix flag is given", func() {
Expand Down Expand Up @@ -526,17 +555,26 @@ pre_ga_user_groups:
Expect(outLoggerBuffer.String()).To(ContainSubstring("Availability: All Users"))
})

It("adds the appropriate OSL file", func() {
It("attaches all license files to the release that match its major and minor", func() {
expectedProductFileIds := []int{version21OslFileID, version21OsmPartOneFileId, version21OsmPartTwoFileId}

err := publish.Execute(args)
Expect(err).NotTo(HaveOccurred())

Expect(pfs.AddToReleaseCallCount()).To(Equal(1))
productSlug, productReleaseID, fileID := pfs.AddToReleaseArgsForCall(0)
Expect(productSlug).To(Equal(slug))
Expect(productReleaseID).To(Equal(releaseID))
Expect(fileID).To(Equal(version21FileID))
Expect(pfs.AddToReleaseCallCount()).To(Equal(3))

var productFileIds []int
for i := 0; i <= 2; i++ {
productSlug, productReleaseID, fileID := pfs.AddToReleaseArgsForCall(i)
Expect(productSlug).To(Equal(slug))
Expect(productReleaseID).To(Equal(releaseID))
productFileIds = append(productFileIds, fileID)
}
Expect(productFileIds).To(Equal(expectedProductFileIds))

Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.1 OSL"))
Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.1 OSM Part 1/2"))
Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.1 OSM Part 2/2"))
})

Context("when the --security-fix flag is given", func() {
Expand Down Expand Up @@ -592,17 +630,26 @@ pre_ga_user_groups:
Expect(outLoggerBuffer.String()).To(ContainSubstring("Availability: All Users"))
})

It("adds the appropriate OSL file", func() {
It("attaches all license files to the release that match its major and minor", func() {
expectedProductFileIds := []int{version21OslFileID, version21OsmPartOneFileId, version21OsmPartTwoFileId}

err := publish.Execute(args)
Expect(err).NotTo(HaveOccurred())

Expect(pfs.AddToReleaseCallCount()).To(Equal(1))
productSlug, productReleaseID, fileID := pfs.AddToReleaseArgsForCall(0)
Expect(productSlug).To(Equal(slug))
Expect(productReleaseID).To(Equal(releaseID))
Expect(fileID).To(Equal(version21FileID))
Expect(pfs.AddToReleaseCallCount()).To(Equal(3))

var productFileIds []int
for i := 0; i <= 2; i++ {
productSlug, productReleaseID, fileID := pfs.AddToReleaseArgsForCall(i)
Expect(productSlug).To(Equal(slug))
Expect(productReleaseID).To(Equal(releaseID))
productFileIds = append(productFileIds, fileID)
}
Expect(productFileIds).To(Equal(expectedProductFileIds))

Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.1 OSL"))
Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.1 OSM Part 1/2"))
Expect(outLoggerBuffer.String()).To(ContainSubstring("License file: PCF Pivotal Application Service v2.1 OSM Part 2/2"))
})

Context("when the --security-fix flag is given", func() {
Expand Down Expand Up @@ -639,14 +686,15 @@ pre_ga_user_groups:

executeArgs []string
outLoggerBuffer strings.Builder
errLoggerBuffer strings.Builder
)

BeforeEach(func() {
publish = commands.Publish{}
publish.Options.Kilnfile = "Kilnfile"
outLoggerBuffer = strings.Builder{}
publish.OutLogger = log.New(&outLoggerBuffer, "", 0)
publish.ErrLogger = log.New(io.Discard, "", 0)
publish.ErrLogger = log.New(&errLoggerBuffer, "", 0)

rs = new(commandsFakes.PivnetReleasesService)
pfs = new(commandsFakes.PivnetProductFilesService)
Expand Down Expand Up @@ -840,20 +888,70 @@ pre_ga_user_groups:
FileVersion: "2.8",
FileType: "Open Source License",
},
{
ID: 43,
Name: "PCF Pivotal Application Service v2.8 OSM Part 1/3",
FileVersion: "2.8",
FileType: "Open Source License",
},
{
ID: 44,
Name: "PCF Pivotal Application Service v2.8 OSM Part 2/3",
FileVersion: "2.8",
FileType: "Open Source License",
},
{
ID: 45,
Name: "PCF Pivotal Application Service v2.8 OSM Part 3/3",
FileVersion: "2.8",
FileType: "Open Source License",
},
},
nil,
)
pfs.AddToReleaseReturns(errors.New("more bad stuff happened"))
})

It("returns an error and makes no changes", func() {
err := publish.Execute(executeArgs)
Expect(err).To(HaveOccurred())
When("the error occurs before any license files have been attached", func() {
BeforeEach(func() {
pfs.AddToReleaseReturns(errors.New("more bad stuff happened"))
})

Expect(rs.UpdateCallCount()).To(Equal(0))
Expect(pfs.ListCallCount()).To(Equal(1))
Expect(pfs.AddToReleaseCallCount()).To(Equal(1))
Expect(err).To(MatchError(ContainSubstring("failed to publish tile: more bad stuff happened")))
It("returns an error and makes no changes", func() {
err := publish.Execute(executeArgs)
Expect(err).To(HaveOccurred())

Expect(rs.UpdateCallCount()).To(Equal(0))
Expect(pfs.ListCallCount()).To(Equal(1))
Expect(pfs.AddToReleaseCallCount()).To(Equal(1))
Expect(err).To(MatchError(ContainSubstring("failed to publish tile: more bad stuff happened")))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring("Attached the following license files before failure:"))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSL"))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSM Part 1/3"))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSM Part 2/3"))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSM Part 3/3"))
})
})

When("the error occurs after some license files have already been attached", func() {
BeforeEach(func() {
pfs.AddToReleaseReturnsOnCall(2, errors.New("more bad stuff happened"))
})

It("returns an error and prints out which product files were already attached", func() {
err := publish.Execute(executeArgs)
Expect(err).To(HaveOccurred())

Expect(rs.UpdateCallCount()).To(Equal(0))
Expect(pfs.ListCallCount()).To(Equal(1))
Expect(pfs.AddToReleaseCallCount()).To(Equal(3))
Expect(err).To(MatchError(ContainSubstring("failed to publish tile: more bad stuff happened")))

Expect(errLoggerBuffer.String()).To(ContainSubstring("Attached the following license files before failure:"))
Expect(errLoggerBuffer.String()).To(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSL"))
Expect(errLoggerBuffer.String()).To(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSM Part 1/3"))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSM Part 2/3"))
Expect(errLoggerBuffer.String()).NotTo(ContainSubstring(" License file: PCF Pivotal Application Service v2.8 OSM Part 3/3"))
})
})
})

Expand Down
Loading