Print image inspect metadata fields in PascalCase

zappy-shu · zappy-shu · commit db258447b196 · 2019-11-20T11:53:05.000Z
Prints the metadata fields in PascalCase when calling `app image
inspect` to match the other fields.

Fixed `FromBundle` func comment

Signed-off-by: Nick Adcock &lt;nick.adcock@docker.com&gt;
diff --git a/e2e/testdata/app-inspect.golden b/e2e/testdata/app-inspect.golden
@@ -1,16 +1,16 @@
 {
     "Metadata": {
-        "version": "1.1.0-beta1",
-        "name": "simple",
-        "description": "new fancy webapp with microservices",
-        "maintainers": [
+        "Version": "1.1.0-beta1",
+        "Name": "simple",
+        "Description": "new fancy webapp with microservices",
+        "Maintainers": [
             {
-                "name": "John Developer",
-                "email": "john.dev@example.com"
+                "Name": "John Developer",
+                "Email": "john.dev@example.com"
             },
             {
-                "name": "Jane Developer",
-                "email": "jane.dev@example.com"
+                "Name": "Jane Developer",
+                "Email": "jane.dev@example.com"
             }
         ]
     },
diff --git a/internal/inspect/testdata/inspect-bundle-json.golden b/internal/inspect/testdata/inspect-bundle-json.golden
@@ -1,16 +1,16 @@
 {
     "Metadata": {
-        "version": "0.1.0",
-        "name": "packing",
-        "description": "hello",
-        "maintainers": [
+        "Version": "0.1.0",
+        "Name": "packing",
+        "Description": "hello",
+        "Maintainers": [
             {
-                "name": "dev1",
-                "email": "dev1@example.com"
+                "Name": "dev1",
+                "Email": "dev1@example.com"
             },
             {
-                "name": "dev2",
-                "email": "dev2@example.com"
+                "Name": "dev2",
+                "Email": "dev2@example.com"
             }
         ]
     },
diff --git a/internal/inspect/testdata/inspect-full-json.golden b/internal/inspect/testdata/inspect-full-json.golden
@@ -1,12 +1,12 @@
 {
     "Metadata": {
-        "version": "0.1.0",
-        "name": "myapp",
-        "description": "some description",
-        "maintainers": [
+        "Version": "0.1.0",
+        "Name": "myapp",
+        "Description": "some description",
+        "Maintainers": [
             {
-                "name": "dev",
-                "email": "dev@example.com"
+                "Name": "dev",
+                "Email": "dev@example.com"
             }
         ]
     },
diff --git a/internal/inspect/testdata/inspect-no-description-json.golden b/internal/inspect/testdata/inspect-no-description-json.golden
@@ -1,11 +1,11 @@
 {
     "Metadata": {
-        "version": "0.1.0",
-        "name": "myapp",
-        "maintainers": [
+        "Version": "0.1.0",
+        "Name": "myapp",
+        "Maintainers": [
             {
-                "name": "dev",
-                "email": "dev@example.com"
+                "Name": "dev",
+                "Email": "dev@example.com"
             }
         ]
     }
diff --git a/internal/inspect/testdata/inspect-no-maintainers-json.golden b/internal/inspect/testdata/inspect-no-maintainers-json.golden
@@ -1,6 +1,6 @@
 {
     "Metadata": {
-        "version": "0.1.0",
-        "name": "myapp"
+        "Version": "0.1.0",
+        "Name": "myapp"
     }
 }
diff --git a/internal/inspect/testdata/inspect-no-parameters-json.golden b/internal/inspect/testdata/inspect-no-parameters-json.golden
@@ -1,12 +1,12 @@
 {
     "Metadata": {
-        "version": "0.1.0",
-        "name": "myapp",
-        "description": "some description",
-        "maintainers": [
+        "Version": "0.1.0",
+        "Name": "myapp",
+        "Description": "some description",
+        "Maintainers": [
             {
-                "name": "dev",
-                "email": "dev@example.com"
+                "Name": "dev",
+                "Email": "dev@example.com"
             }
         ]
     }
diff --git a/internal/inspect/testdata/inspect-overridden-json.golden b/internal/inspect/testdata/inspect-overridden-json.golden
@@ -1,7 +1,7 @@
 {
     "Metadata": {
-        "version": "0.1.0",
-        "name": "myapp"
+        "Version": "0.1.0",
+        "Name": "myapp"
     },
     "Services": [
         {
diff --git a/types/metadata/metadata.go b/types/metadata/metadata.go
@@ -8,8 +8,8 @@ import (
 
 // Maintainer represents one of the apps's maintainers
 type Maintainer struct {
-	Name  string `json:"name"`
-	Email string `json:"email,omitempty"`
+	Name  string
+	Email string `json:",omitempty"`
 }
 
 // Maintainers is a list of maintainers
@@ -35,13 +35,13 @@ func (m Maintainer) String() string {
 
 // AppMetadata is the format of the data found inside the metadata.yml file
 type AppMetadata struct {
-	Version     string      `json:"version"`
-	Name        string      `json:"name"`
-	Description string      `json:"description,omitempty"`
-	Maintainers Maintainers `json:"maintainers,omitempty"`
+	Version     string
+	Name        string
+	Description string      `json:",omitempty"`
+	Maintainers Maintainers `json:",omitempty"`
 }
 
-// Metadata extracts the docker-app metadata from the bundle
+// FromBundle extracts the docker-app metadata from the bundle
 func FromBundle(bndl *bundle.Bundle) AppMetadata {
 	meta := AppMetadata{
 		Name:        bndl.Name,

Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`	`1`	`{`
`2`	`2`	`"Metadata": {`
`3`		`- "version": "1.1.0-beta1",`
`4`		`- "name": "simple",`
`5`		`- "description": "new fancy webapp with microservices",`
`6`		`- "maintainers": [`
	`3`	`+ "Version": "1.1.0-beta1",`
	`4`	`+ "Name": "simple",`
	`5`	`+ "Description": "new fancy webapp with microservices",`
	`6`	`+ "Maintainers": [`
`7`	`7`	`{`
`8`		`- "name": "John Developer",`
`9`		`- "email": "[email protected]"`
	`8`	`+ "Name": "John Developer",`
	`9`	`+ "Email": "[email protected]"`
`10`	`10`	`},`
`11`	`11`	`{`
`12`		`- "name": "Jane Developer",`
`13`		`- "email": "[email protected]"`
	`12`	`+ "Name": "Jane Developer",`
	`13`	`+ "Email": "[email protected]"`
`14`	`14`	`}`
`15`	`15`	`]`
`16`	`16`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`	`1`	`{`
`2`	`2`	`"Metadata": {`
`3`		`- "version": "0.1.0",`
`4`		`- "name": "packing",`
`5`		`- "description": "hello",`
`6`		`- "maintainers": [`
	`3`	`+ "Version": "0.1.0",`
	`4`	`+ "Name": "packing",`
	`5`	`+ "Description": "hello",`
	`6`	`+ "Maintainers": [`
`7`	`7`	`{`
`8`		`- "name": "dev1",`
`9`		`- "email": "[email protected]"`
	`8`	`+ "Name": "dev1",`
	`9`	`+ "Email": "[email protected]"`
`10`	`10`	`},`
`11`	`11`	`{`
`12`		`- "name": "dev2",`
`13`		`- "email": "[email protected]"`
	`12`	`+ "Name": "dev2",`
	`13`	`+ "Email": "[email protected]"`
`14`	`14`	`}`
`15`	`15`	`]`
`16`	`16`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`{`
`2`	`2`	`"Metadata": {`
`3`		`- "version": "0.1.0",`
`4`		`- "name": "myapp",`
`5`		`- "description": "some description",`
`6`		`- "maintainers": [`
	`3`	`+ "Version": "0.1.0",`
	`4`	`+ "Name": "myapp",`
	`5`	`+ "Description": "some description",`
	`6`	`+ "Maintainers": [`
`7`	`7`	`{`
`8`		`- "name": "dev",`
`9`		`- "email": "[email protected]"`
	`8`	`+ "Name": "dev",`
	`9`	`+ "Email": "[email protected]"`
`10`	`10`	`}`
`11`	`11`	`]`
`12`	`12`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`	`1`	`{`
`2`	`2`	`"Metadata": {`
`3`		`- "version": "0.1.0",`
`4`		`- "name": "myapp",`
`5`		`- "maintainers": [`
	`3`	`+ "Version": "0.1.0",`
	`4`	`+ "Name": "myapp",`
	`5`	`+ "Maintainers": [`
`6`	`6`	`{`
`7`		`- "name": "dev",`
`8`		`- "email": "[email protected]"`
	`7`	`+ "Name": "dev",`
	`8`	`+ "Email": "[email protected]"`
`9`	`9`	`}`
`10`	`10`	`]`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"Metadata": {`
`3`		`- "version": "0.1.0",`
`4`		`- "name": "myapp"`
	`3`	`+ "Version": "0.1.0",`
	`4`	`+ "Name": "myapp"`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"Metadata": {`
`3`		`- "version": "0.1.0",`
`4`		`- "name": "myapp"`
	`3`	`+ "Version": "0.1.0",`
	`4`	`+ "Name": "myapp"`
`5`	`5`	`},`
`6`	`6`	`"Services": [`
`7`	`7`	`{`