include a file containing all compnents' licenses in the tarballs (#7)

* include a file containing all compnents' licenses in the tarballs

* feedback

Author: sammy-da

.gitattributes

@@ -1 +1,3 @@
 docs/cli/** linguist-generated
+LICENSE text eol=lf
+*.golden text eol=lf

cmd/dpm/cmd/repo_test.go

@@ -13,6 +13,7 @@ import (
 	"testing"
 
 	"daml.com/x/assistant/pkg/assistantconfig"
+	"daml.com/x/assistant/pkg/licenseutils"
 	"daml.com/x/assistant/pkg/ocilister"
 	"daml.com/x/assistant/pkg/sdkmanifest"
 	"daml.com/x/assistant/pkg/testutil"
@@ -56,6 +57,22 @@ func (suite *RepoSuite) TestRepoCreateTarball() {
 		assert.NoError(t, w.Close())
 	})
 
+	t.Run("LICENSES file", func(t *testing.T) {
+		entries, err := os.ReadDir(bundlePath)
+		require.NoError(t, err)
+		for _, platformBundle := range entries {
+			expected, err := os.ReadFile(testutil.TestdataPath(t, "licenses-for-publish-yaml-tarballs", "unix.golden"))
+			if platformBundle.Name() == "windows-amd64" {
+				expected, err = os.ReadFile(testutil.TestdataPath(t, "licenses-for-publish-yaml-tarballs", "windows.golden"))
+			}
+			require.NoError(t, err)
+
+			got, err := os.ReadFile(filepath.Join(bundlePath, platformBundle.Name(), licenseutils.TarballLicensesFilename))
+			require.NoError(t, err)
+			assert.Equal(t, string(expected), string(got))
+		}
+	})
+
 	t.Run("bootstrap from bundle", func(t *testing.T) {
 		cmd := createStdTestRootCmd(t)
 		// TODO this command should refuse to bootstrap a bundle

pkg/licenseutils/licenseutils.go

@@ -0,0 +1,46 @@
+package licenseutils
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"sort"
+	"strings"
+
+	"github.com/samber/lo"
+)
+
+const ComponentLicenseFilename = "LICENSE"
+const TarballLicensesFilename = "LICENSES"
+
+// WriteLicensesFile combines components licenses into single LICENSES file.
+// licenses is map from component name to its LICENSE's file path
+func WriteLicensesFile(licenses map[string]string, outputDir string) error {
+	var b strings.Builder
+
+	// Header
+	fmt.Fprintln(&b, "LICENSES")
+	fmt.Fprintln(&b, "============================================================")
+	fmt.Fprintln(&b, "")
+	fmt.Fprintln(&b, "This product includes multiple software components.")
+	fmt.Fprint(&b, "The license terms for each component are provided below.")
+
+	sortedComponents := lo.Keys(licenses)
+	sort.Strings(sortedComponents)
+
+	for _, comp := range sortedComponents {
+		license, err := os.ReadFile(licenses[comp])
+		if err != nil {
+			return err
+		}
+
+		fmt.Fprintln(&b, "")
+		fmt.Fprintln(&b, "")
+		fmt.Fprintln(&b, "------------------------------------------------------------")
+		fmt.Fprintf(&b, "Component: %s\n\n", comp)
+		b.WriteString(strings.TrimSpace(string(license)))
+	}
+	fmt.Fprintln(&b, "")
+
+	return os.WriteFile(filepath.Join(outputDir, TarballLicensesFilename), []byte(b.String()), 0644)
+}

pkg/publish/publish.go

@@ -16,6 +16,7 @@ import (
 
 	"daml.com/x/assistant/pkg/assembler"
 	"daml.com/x/assistant/pkg/assistantconfig/assistantremote"
+	"daml.com/x/assistant/pkg/licenseutils"
 	ociconsts "daml.com/x/assistant/pkg/oci"
 	"daml.com/x/assistant/pkg/ociindex"
 	"daml.com/x/assistant/pkg/ocilister"
@@ -372,10 +373,10 @@ func checkHasLicense(dir string) error {
 		return err
 	}
 	_, ok := lo.Find(des, func(de os.DirEntry) bool {
-		return de.Name() == "LICENSE" && de.Type().IsRegular()
+		return de.Name() == licenseutils.ComponentLicenseFilename && de.Type().IsRegular()
 	})
 	if !ok {
-		return fmt.Errorf("required LICENSE file is missing at component root (%q)", dir)
+		return fmt.Errorf("required %s file is missing at component root (%q)", licenseutils.ComponentLicenseFilename, dir)
 	}
 	return nil
 }

pkg/sdkbundle/sdkbundle.go

@@ -16,6 +16,7 @@ import (
 	"daml.com/x/assistant/pkg/assembler"
 	"daml.com/x/assistant/pkg/assistantconfig"
 	"daml.com/x/assistant/pkg/assistantconfig/assistantremote"
+	"daml.com/x/assistant/pkg/licenseutils"
 	ociconsts "daml.com/x/assistant/pkg/oci"
 	"daml.com/x/assistant/pkg/ociindex"
 	"daml.com/x/assistant/pkg/ocipuller/localpuller"
@@ -195,6 +196,7 @@ func createFromManifest(ctx context.Context, client *assistantremote.Remote, man
 
 	comps := lo.Values(manifest.Spec.Components)
 	comps = append(comps, manifest.Spec.Assistant)
+	licenses := make(map[string]string)
 	for _, comp := range comps {
 		repoName := ociconsts.ComponentRepoPrefix + comp.Name
 		tag := assembler.ComputeTagOrDigest(comp)
@@ -204,12 +206,19 @@ func createFromManifest(ctx context.Context, client *assistantremote.Remote, man
 			return "", fmt.Errorf("failed to pull component '%s:%s'. %w", repoName, tag, err)
 		}
 
+		imageManifestPath := filepath.Join(localRegistryPath, repoName, "blobs", "sha256", desc.Digest.Hex())
+
 		// put a symlink to the assistant binary at known location in the bundle
 		if comp == manifest.Spec.Assistant {
-			imageManifestPath := filepath.Join(localRegistryPath, repoName, "blobs", "sha256", desc.Digest.Hex())
-			if err := linkAssistant(platformBundlePath, imageManifestPath); err != nil {
+			if err := linkAssistant(platform, platformBundlePath, imageManifestPath); err != nil {
 				return "", err
 			}
+		} else {
+			licenseBlob, _, err := findFileInOciBlobs(imageManifestPath, licenseutils.ComponentLicenseFilename)
+			if err != nil {
+				return "", fmt.Errorf("couldn't find file named %q in component %q: %w", licenseutils.ComponentLicenseFilename, comp.Name, err)
+			}
+			licenses[comp.Name] = licenseBlob
 		}
 	}
 
@@ -237,33 +246,59 @@ func createFromManifest(ctx context.Context, client *assistantremote.Remote, man
 		return "", err
 	}
 
+	fmt.Printf("Writing LICENSES file for platform %q\n", platform.String())
+	if err := licenseutils.WriteLicensesFile(licenses, filepath.Join(platformBundlePath)); err != nil {
+		return "", err
+	}
+
 	fmt.Printf("Bundle for %s created at %q.\n", platform.String(), platformBundlePath)
 	return platformBundlePath, nil
 }
 
-func linkAssistant(dir, imageManifestPath string) error {
+// findFileInOciBlobs returns the path to the blob (which has hashy name) of the desired file
+func findFileInOciBlobs(imageManifestPath, filename string) (string, *v1.Descriptor, error) {
 	bytes, err := os.ReadFile(imageManifestPath)
 	if err != nil {
-		return err
+		return "", nil, err
 	}
 	manifest := v1.Manifest{}
 	if err := json.Unmarshal(bytes, &manifest); err != nil {
-		return err
+		return "", nil, err
 	}
 
-	dpmBinLayer, ok := lo.Find(manifest.Layers, func(l v1.Descriptor) bool {
-		filename, ok := l.Annotations[fileinfo.FileNameAnnotation]
+	layer, ok := lo.Find(manifest.Layers, func(l v1.Descriptor) bool {
+		fname, ok := l.Annotations[fileinfo.FileNameAnnotation]
 		if !ok {
 			slog.Warn("layer missing annotation", "annotation", fileinfo.FileNameAnnotation)
 			return false
 		}
-		return filename == assembler.AssistantBinNameWindows || filename == assembler.AssistantBinNameUnix
+		return fname == filename
 	})
 
 	if !ok {
-		return fmt.Errorf("could not determine assistant binary's layer")
+		return "", nil, fmt.Errorf("could not determine file's OCI layer for filename %q", filename)
+	}
+	return filepath.Join(filepath.Dir(imageManifestPath), layer.Digest.Hex()), &layer, nil
+}
+
+func linkAssistant(platform *simpleplatform.NonGeneric, dir, imageManifestPath string) error {
+	bytes, err := os.ReadFile(imageManifestPath)
+	if err != nil {
+		return err
+	}
+	manifest := v1.Manifest{}
+	if err := json.Unmarshal(bytes, &manifest); err != nil {
+		return err
+	}
+
+	binFileName := assembler.AssistantBinNameUnix
+	if platform.OS == "windows" {
+		binFileName = assembler.AssistantBinNameWindows
+	}
+	binBlobPath, dpmBinLayer, err := findFileInOciBlobs(imageManifestPath, binFileName)
+	if err != nil {
+		return fmt.Errorf("could not determine assistant binary's layer and file: %w", err)
 	}
-	binBlobPath := filepath.Join(filepath.Dir(imageManifestPath), dpmBinLayer.Digest.Hex())
 
 	// TODO figure out why running linked blob fails on windows, instead of this.
 	// (seems windows isn't happy with the blob filename not having a .exe)

pkg/testutil/testdata/components/rando/LICENSE

@@ -0,0 +1 @@
+rando dummy test license

pkg/testutil/testdata/javabro-component/LICENSE

@@ -0,0 +1 @@
+javabro dummy test license

pkg/testutil/testdata/licenses-for-publish-yaml-tarballs/unix.golden

@@ -0,0 +1,20 @@
+LICENSES
+============================================================
+
+This product includes multiple software components.
+The license terms for each component are provided below.
+
+------------------------------------------------------------
+Component: javabro
+
+javabro dummy test license
+
+------------------------------------------------------------
+Component: meep
+
+meepy dummy test license
+
+------------------------------------------------------------
+Component: no-windows
+
+rando dummy test license

pkg/testutil/testdata/licenses-for-publish-yaml-tarballs/windows.golden

@@ -0,0 +1,15 @@
+LICENSES
+============================================================
+
+This product includes multiple software components.
+The license terms for each component are provided below.
+
+------------------------------------------------------------
+Component: javabro
+
+javabro dummy test license
+
+------------------------------------------------------------
+Component: meep
+
+meepy dummy test license

pkg/testutil/testdata/meepy-component/unix/LICENSE

@@ -0,0 +1 @@
+meepy dummy test license