Add buildpack name to buildpack and builder metadata

sambhav · sambhav · commit d3a7f3590e16 · 2021-03-29T23:06:42.000+01:00
Signed-off-by: Sambhav Kothari &lt;skothari44@bloomberg.net&gt;
diff --git a/acceptance/testdata/pack_fixtures/inspect_builder_nested_depth_2_output.txt b/acceptance/testdata/pack_fixtures/inspect_builder_nested_depth_2_output.txt
@@ -31,13 +31,13 @@ Run Images:
   {{.run_image_mirror}}
 
 Buildpacks:
-  ID                           VERSION                             HOMEPAGE
-  noop.buildpack               noop.buildpack.later-version        http://geocities.com/cool-bp
-  noop.buildpack               noop.buildpack.version              -
-  read/env                     read-env-version                    -
-  simple/layers                simple-layers-version               -
-  simple/nested-level-1        nested-l1-version                   -
-  simple/nested-level-2        nested-l2-version                   -
+  ID                           NAME                      VERSION                             HOMEPAGE
+  noop.buildpack               NOOP Buildpack            noop.buildpack.later-version        http://geocities.com/cool-bp
+  noop.buildpack               NOOP Buildpack            noop.buildpack.version              -
+  read/env                     Read Env Buildpack        read-env-version                    -
+  simple/layers                -                         simple-layers-version               -
+  simple/nested-level-1        -                         nested-l1-version                   -
+  simple/nested-level-2        -                         nested-l2-version                   -
 
 Detection Order:
  └ Group #1:
@@ -77,13 +77,13 @@ Run Images:
   {{.run_image_mirror}}
 
 Buildpacks:
-  ID                           VERSION                             HOMEPAGE
-  noop.buildpack               noop.buildpack.later-version        http://geocities.com/cool-bp
-  noop.buildpack               noop.buildpack.version              -
-  read/env                     read-env-version                    -
-  simple/layers                simple-layers-version               -
-  simple/nested-level-1        nested-l1-version                   -
-  simple/nested-level-2        nested-l2-version                   -
+  ID                           NAME                      VERSION                             HOMEPAGE
+  noop.buildpack               NOOP Buildpack            noop.buildpack.later-version        http://geocities.com/cool-bp
+  noop.buildpack               NOOP Buildpack            noop.buildpack.version              -
+  read/env                     Read Env Buildpack        read-env-version                    -
+  simple/layers                -                         simple-layers-version               -
+  simple/nested-level-1        -                         nested-l1-version                   -
+  simple/nested-level-2        -                         nested-l2-version                   -
 
 Detection Order:
  └ Group #1:
diff --git a/acceptance/testdata/pack_fixtures/inspect_builder_nested_output.txt b/acceptance/testdata/pack_fixtures/inspect_builder_nested_output.txt
@@ -31,13 +31,13 @@ Run Images:
   {{.run_image_mirror}}
 
 Buildpacks:
-  ID                           VERSION                             HOMEPAGE
-  noop.buildpack               noop.buildpack.later-version        http://geocities.com/cool-bp
-  noop.buildpack               noop.buildpack.version              -
-  read/env                     read-env-version                    -
-  simple/layers                simple-layers-version               -
-  simple/nested-level-1        nested-l1-version                   -
-  simple/nested-level-2        nested-l2-version                   -
+  ID                           NAME                      VERSION                             HOMEPAGE
+  noop.buildpack               NOOP Buildpack            noop.buildpack.later-version        http://geocities.com/cool-bp
+  noop.buildpack               NOOP Buildpack            noop.buildpack.version              -
+  read/env                     Read Env Buildpack        read-env-version                    -
+  simple/layers                -                         simple-layers-version               -
+  simple/nested-level-1        -                         nested-l1-version                   -
+  simple/nested-level-2        -                         nested-l2-version                   -
 
 Detection Order:
  └ Group #1:
@@ -79,13 +79,13 @@ Run Images:
   {{.run_image_mirror}}
 
 Buildpacks:
-  ID                           VERSION                             HOMEPAGE
-  noop.buildpack               noop.buildpack.later-version        http://geocities.com/cool-bp
-  noop.buildpack               noop.buildpack.version              -
-  read/env                     read-env-version                    -
-  simple/layers                simple-layers-version               -
-  simple/nested-level-1        nested-l1-version                   -
-  simple/nested-level-2        nested-l2-version                   -
+  ID                           NAME                      VERSION                             HOMEPAGE
+  noop.buildpack               NOOP Buildpack            noop.buildpack.later-version        http://geocities.com/cool-bp
+  noop.buildpack               NOOP Buildpack            noop.buildpack.version              -
+  read/env                     Read Env Buildpack        read-env-version                    -
+  simple/layers                -                         simple-layers-version               -
+  simple/nested-level-1        -                         nested-l1-version                   -
+  simple/nested-level-2        -                         nested-l2-version                   -
 
 Detection Order:
  └ Group #1:
diff --git a/acceptance/testdata/pack_fixtures/inspect_builder_nested_output_json.txt b/acceptance/testdata/pack_fixtures/inspect_builder_nested_output_json.txt
@@ -42,15 +42,18 @@
     "buildpacks": [
       {
         "id": "noop.buildpack",
+        "name": "NOOP Buildpack",
         "version": "noop.buildpack.later-version",
         "homepage": "http://geocities.com/cool-bp"
       },
       {
         "id": "noop.buildpack",
+        "name": "NOOP Buildpack",
         "version": "noop.buildpack.version"
       },
       {
         "id": "read/env",
+        "name": "Read Env Buildpack",
         "version": "read-env-version"
       },
       {
@@ -133,15 +136,18 @@
     "buildpacks": [
       {
         "id": "noop.buildpack",
+        "name": "NOOP Buildpack",
         "version": "noop.buildpack.later-version",
         "homepage": "http://geocities.com/cool-bp"
       },
       {
         "id": "noop.buildpack",
+        "name": "NOOP Buildpack",
         "version": "noop.buildpack.version"
       },
       {
         "id": "read/env",
+        "name": "Read Env Buildpack",
         "version": "read-env-version"
       },
       {
diff --git a/acceptance/testdata/pack_fixtures/inspect_builder_nested_output_toml.txt b/acceptance/testdata/pack_fixtures/inspect_builder_nested_output_toml.txt
@@ -35,15 +35,18 @@ default = false
 
   [[remote_info.buildpacks]]
     id = "noop.buildpack"
+    name = "NOOP Buildpack"
     version = "noop.buildpack.later-version"
     homepage = "http://geocities.com/cool-bp"
 
   [[remote_info.buildpacks]]
     id = "noop.buildpack"
+    name = "NOOP Buildpack"
     version = "noop.buildpack.version"
 
   [[remote_info.buildpacks]]
     id = "read/env"
+    name = "Read Env Buildpack"
     version = "read-env-version"
 
   [[remote_info.buildpacks]]
@@ -109,15 +112,18 @@ default = false
 
   [[local_info.buildpacks]]
     id = "noop.buildpack"
+    name = "NOOP Buildpack"
     version = "noop.buildpack.later-version"
     homepage = "http://geocities.com/cool-bp"
 
   [[local_info.buildpacks]]
     id = "noop.buildpack"
+    name = "NOOP Buildpack"
     version = "noop.buildpack.version"
 
   [[local_info.buildpacks]]
     id = "read/env"
+    name = "Read Env Buildpack"
     version = "read-env-version"
 
   [[local_info.buildpacks]]
diff --git a/acceptance/testdata/pack_fixtures/inspect_builder_nested_output_yaml.txt b/acceptance/testdata/pack_fixtures/inspect_builder_nested_output_yaml.txt
@@ -28,11 +28,14 @@ remote_info:
         - name: {{.run_image_mirror}}
     buildpacks:
         - id: noop.buildpack
+          name: NOOP Buildpack
           version: noop.buildpack.later-version
           homepage: http://geocities.com/cool-bp
         - id: noop.buildpack
+          name: NOOP Buildpack
           version: noop.buildpack.version
         - id: read/env
+          name: Read Env Buildpack
           version: read-env-version
         - id: simple/layers
           version: simple-layers-version
@@ -78,11 +81,14 @@ local_info:
         - name: {{.run_image_mirror}}
     buildpacks:
         - id: noop.buildpack
+          name: NOOP Buildpack
           version: noop.buildpack.later-version
           homepage: http://geocities.com/cool-bp
         - id: noop.buildpack
+          name: NOOP Buildpack
           version: noop.buildpack.version
         - id: read/env
+          name: Read Env Buildpack
           version: read-env-version
         - id: simple/layers
           version: simple-layers-version
diff --git a/acceptance/testdata/pack_fixtures/inspect_builder_output.txt b/acceptance/testdata/pack_fixtures/inspect_builder_output.txt
@@ -31,11 +31,11 @@ Run Images:
   {{.run_image_mirror}}
 
 Buildpacks:
-  ID                    VERSION                             HOMEPAGE
-  noop.buildpack        noop.buildpack.later-version        http://geocities.com/cool-bp
-  noop.buildpack        noop.buildpack.version              -
-  read/env              read-env-version                    -
-  simple/layers         simple-layers-version               -
+  ID                    NAME                      VERSION                             HOMEPAGE
+  noop.buildpack        NOOP Buildpack            noop.buildpack.later-version        http://geocities.com/cool-bp
+  noop.buildpack        NOOP Buildpack            noop.buildpack.version              -
+  read/env              Read Env Buildpack        read-env-version                    -
+  simple/layers         -                         simple-layers-version               -
 
 Detection Order:
  └ Group #1:
@@ -73,11 +73,11 @@ Run Images:
   {{.run_image_mirror}}
 
 Buildpacks:
-  ID                    VERSION                             HOMEPAGE
-  noop.buildpack        noop.buildpack.later-version        http://geocities.com/cool-bp
-  noop.buildpack        noop.buildpack.version              -
-  read/env              read-env-version                    -
-  simple/layers         simple-layers-version               -
+  ID                    NAME                      VERSION                             HOMEPAGE
+  noop.buildpack        NOOP Buildpack            noop.buildpack.later-version        http://geocities.com/cool-bp
+  noop.buildpack        NOOP Buildpack            noop.buildpack.version              -
+  read/env              Read Env Buildpack        read-env-version                    -
+  simple/layers         -                         simple-layers-version               -
 
 Detection Order:
  └ Group #1:
diff --git a/acceptance/testdata/pack_fixtures/inspect_buildpack_output.txt b/acceptance/testdata/pack_fixtures/inspect_buildpack_output.txt
@@ -8,9 +8,9 @@ Stacks:
       (none)
 
 Buildpacks:
-  ID                          VERSION                             HOMEPAGE
-  simple/layers               simple-layers-version               -
-  simple/layers/parent        simple-layers-parent-version        -
+  ID                          NAME                                  VERSION                             HOMEPAGE
+  simple/layers               Simple Layers Buildpack               simple-layers-version               -
+  simple/layers/parent        Simple Layers Parent Buildpack        simple-layers-parent-version        -
 
 Detection Order:
  └ Group #1:
diff --git a/inspect_builder_test.go b/inspect_builder_test.go
@@ -126,7 +126,8 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {
 	{
       "id": "test.bp.one",
 	  "version": "test.bp.one.version",
-	  "homepage": "http://geocities.com/cool-bp"
+	  "homepage": "http://geocities.com/cool-bp",
+	  "name": "one"
     },
 	{
       "id": "test.bp.two",
@@ -197,7 +198,8 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {
         }
       ],
       "layerDiffID": "sha256:test.bp.one.sha256",
-	  "homepage": "http://geocities.com/cool-bp"
+	  "homepage": "http://geocities.com/cool-bp",
+	  "name": "one"
     }
   },
  "test.bp.two": {
@@ -230,6 +232,7 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {
 								{
 									ID:       "test.bp.one",
 									Version:  "test.bp.one.version",
+									Name:     "one",
 									Homepage: "http://geocities.com/cool-bp",
 								},
 								{
@@ -298,6 +301,7 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {
 										},
 										LayerDiffID: "sha256:test.bp.one.sha256",
 										Homepage:    "http://geocities.com/cool-bp",
+										Name:        "one",
 									},
 								},
 								"test.bp.two": {
diff --git a/inspect_buildpack.go b/inspect_buildpack.go
@@ -143,6 +143,7 @@ func extractBuildpacks(layersMd dist.BuildpackLayers) []dist.BuildpackInfo {
 		for version, layerInfo := range buildpackMap {
 			bp := dist.BuildpackInfo{
 				ID:       buildpackID,
+				Name:     layerInfo.Name,
 				Version:  version,
 				Homepage: layerInfo.Homepage,
 			}
diff --git a/inspect_buildpack_test.go b/inspect_buildpack_test.go
@@ -41,6 +41,7 @@ import (
 const buildpackageMetadataTag = `{
   "id": "some/top-buildpack",
   "version": "0.0.1",
+  "name": "top",
   "homepage": "top-buildpack-homepage",
   "stacks": [
     {
@@ -144,7 +145,8 @@ const buildpackLayersTag = `{
             }
          ],
          "layerDiffID":"sha256:top-buildpack-diff-id",
-         "homepage":"top-buildpack-homepage"
+         "homepage":"top-buildpack-homepage",
+		 "name": "top"
       }
    }
 }`
@@ -198,6 +200,7 @@ func testInspectBuildpack(t *testing.T, when spec.G, it spec.S) {
 				BuildpackInfo: dist.BuildpackInfo{
 					ID:       "some/top-buildpack",
 					Version:  "0.0.1",
+					Name:     "top",
 					Homepage: "top-buildpack-homepage",
 				},
 				Stacks: []dist.Stack{
@@ -224,6 +227,7 @@ func testInspectBuildpack(t *testing.T, when spec.G, it spec.S) {
 				{
 					ID:       "some/top-buildpack",
 					Version:  "0.0.1",
+					Name:     "top",
 					Homepage: "top-buildpack-homepage",
 				},
 			},
@@ -234,6 +238,7 @@ func testInspectBuildpack(t *testing.T, when spec.G, it spec.S) {
 							BuildpackInfo: dist.BuildpackInfo{
 								ID:       "some/top-buildpack",
 								Version:  "0.0.1",
+								Name:     "top",
 								Homepage: "top-buildpack-homepage",
 							},
 							Optional: false,
@@ -340,6 +345,7 @@ func testInspectBuildpack(t *testing.T, when spec.G, it spec.S) {
 						},
 						LayerDiffID: "sha256:top-buildpack-diff-id",
 						Homepage:    "top-buildpack-homepage",
+						Name:        "top",
 					},
 				},
 			},
diff --git a/internal/builder/writer/human_readable.go b/internal/builder/writer/human_readable.go
@@ -293,13 +293,13 @@ func buildpacksOutput(buildpacks []dist.BuildpackInfo, builderName string) (stri
 		buildpacksTabWriter = tabwriter.NewWriter(spaceStrippingWriter, writerMinWidth, writerPadChar, buildpacksTabWidth, writerPadChar, writerFlags)
 	)
 
-	_, err := fmt.Fprint(buildpacksTabWriter, "  ID\tVERSION\tHOMEPAGE\n")
+	_, err := fmt.Fprint(buildpacksTabWriter, "  ID\tNAME\tVERSION\tHOMEPAGE\n")
 	if err != nil {
 		return "", []string{}, fmt.Errorf("writing to tab writer: %w", err)
 	}
 
 	for _, b := range buildpacks {
-		_, err = fmt.Fprintf(buildpacksTabWriter, "  %s\t%s\t%s\n", b.ID, b.Version, strs.ValueOrDefault(b.Homepage, "-"))
+		_, err = fmt.Fprintf(buildpacksTabWriter, "  %s\t%s\t%s\t%s\n", b.ID, strs.ValueOrDefault(b.Name, "-"), b.Version, strs.ValueOrDefault(b.Homepage, "-"))
 		if err != nil {
 			return "", []string{}, fmt.Errorf("writing to tab writer: %w", err)
 		}
diff --git a/internal/builder/writer/human_readable_test.go b/internal/builder/writer/human_readable_test.go
@@ -67,12 +67,12 @@ Run Images:
   second/default
 
 Buildpacks:
-  ID                     VERSION                        HOMEPAGE
-  test.top.nested        test.top.nested.version        -
-  test.nested                                           http://geocities.com/top-bp
-  test.bp.one            test.bp.one.version            http://geocities.com/cool-bp
-  test.bp.two            test.bp.two.version            -
-  test.bp.three          test.bp.three.version          -
+  ID                     NAME        VERSION                        HOMEPAGE
+  test.top.nested        -           test.top.nested.version        -
+  test.nested            -                                          http://geocities.com/top-bp
+  test.bp.one            -           test.bp.one.version            http://geocities.com/cool-bp
+  test.bp.two            -           test.bp.two.version            -
+  test.bp.three          -           test.bp.three.version          -
 
 Detection Order:
  ├ Group #1:
@@ -120,12 +120,12 @@ Run Images:
   second/local-default
 
 Buildpacks:
-  ID                     VERSION                        HOMEPAGE
-  test.top.nested        test.top.nested.version        -
-  test.nested                                           http://geocities.com/top-bp
-  test.bp.one            test.bp.one.version            http://geocities.com/cool-bp
-  test.bp.two            test.bp.two.version            -
-  test.bp.three          test.bp.three.version          -
+  ID                     NAME        VERSION                        HOMEPAGE
+  test.top.nested        -           test.top.nested.version        -
+  test.nested            -                                          http://geocities.com/top-bp
+  test.bp.one            -           test.bp.one.version            http://geocities.com/cool-bp
+  test.bp.two            -           test.bp.two.version            -
+  test.bp.three          -           test.bp.three.version          -
 
 Detection Order:
  ├ Group #1:
diff --git a/internal/buildpackage/builder_test.go b/internal/buildpackage/builder_test.go
diff --git a/internal/commands/buildpack_inspect_test.go b/internal/commands/buildpack_inspect_test.go
diff --git a/internal/commands/inspect_buildpack.go b/internal/commands/inspect_buildpack.go
diff --git a/internal/dist/buildpack.go b/internal/dist/buildpack.go
diff --git a/internal/dist/dist.go b/internal/dist/dist.go

Original file line number	Diff line number	Diff line change
`@@ -42,15 +42,18 @@`
`42`	`42`	`"buildpacks": [`
`43`	`43`	`{`
`44`	`44`	`"id": "noop.buildpack",`
	`45`	`+ "name": "NOOP Buildpack",`
`45`	`46`	`"version": "noop.buildpack.later-version",`
`46`	`47`	`"homepage": "http://geocities.com/cool-bp"`
`47`	`48`	`},`
`48`	`49`	`{`
`49`	`50`	`"id": "noop.buildpack",`
	`51`	`+ "name": "NOOP Buildpack",`
`50`	`52`	`"version": "noop.buildpack.version"`
`51`	`53`	`},`
`52`	`54`	`{`
`53`	`55`	`"id": "read/env",`
	`56`	`+ "name": "Read Env Buildpack",`
`54`	`57`	`"version": "read-env-version"`
`55`	`58`	`},`
`56`	`59`	`{`
`@@ -133,15 +136,18 @@`
`133`	`136`	`"buildpacks": [`
`134`	`137`	`{`
`135`	`138`	`"id": "noop.buildpack",`
	`139`	`+ "name": "NOOP Buildpack",`
`136`	`140`	`"version": "noop.buildpack.later-version",`
`137`	`141`	`"homepage": "http://geocities.com/cool-bp"`
`138`	`142`	`},`
`139`	`143`	`{`
`140`	`144`	`"id": "noop.buildpack",`
	`145`	`+ "name": "NOOP Buildpack",`
`141`	`146`	`"version": "noop.buildpack.version"`
`142`	`147`	`},`
`143`	`148`	`{`
`144`	`149`	`"id": "read/env",`
	`150`	`+ "name": "Read Env Buildpack",`
`145`	`151`	`"version": "read-env-version"`
`146`	`152`	`},`
`147`	`153`	`{`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,8 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {`
`126`	`126`	`{`
`127`	`127`	`"id": "test.bp.one",`
`128`	`128`	`"version": "test.bp.one.version",`
`129`		`- "homepage": "http://geocities.com/cool-bp"`
	`129`	`+ "homepage": "http://geocities.com/cool-bp",`
	`130`	`+ "name": "one"`
`130`	`131`	`},`
`131`	`132`	`{`
`132`	`133`	`"id": "test.bp.two",`
`@@ -197,7 +198,8 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {`
`197`	`198`	`}`
`198`	`199`	`],`
`199`	`200`	`"layerDiffID": "sha256:test.bp.one.sha256",`
`200`		`- "homepage": "http://geocities.com/cool-bp"`
	`201`	`+ "homepage": "http://geocities.com/cool-bp",`
	`202`	`+ "name": "one"`
`201`	`203`	`}`
`202`	`204`	`},`
`203`	`205`	`"test.bp.two": {`
`@@ -230,6 +232,7 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {`
`230`	`232`	`{`
`231`	`233`	`ID: "test.bp.one",`
`232`	`234`	`Version: "test.bp.one.version",`
	`235`	`+ Name: "one",`
`233`	`236`	`Homepage: "http://geocities.com/cool-bp",`
`234`	`237`	`},`
`235`	`238`	`{`
`@@ -298,6 +301,7 @@ func testInspectBuilder(t *testing.T, when spec.G, it spec.S) {`
`298`	`301`	`},`
`299`	`302`	`LayerDiffID: "sha256:test.bp.one.sha256",`
`300`	`303`	`Homepage: "http://geocities.com/cool-bp",`
	`304`	`+ Name: "one",`
`301`	`305`	`},`
`302`	`306`	`},`
`303`	`307`	`"test.bp.two": {`
Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,7 @@ func extractBuildpacks(layersMd dist.BuildpackLayers) []dist.BuildpackInfo {`
`143`	`143`	`for version, layerInfo := range buildpackMap {`
`144`	`144`	`bp := dist.BuildpackInfo{`
`145`	`145`	`ID: buildpackID,`
	`146`	`+ Name: layerInfo.Name,`
`146`	`147`	`Version: version,`
`147`	`148`	`Homepage: layerInfo.Homepage,`
`148`	`149`	`}`