Merge pull request #638 from laverya/change-state.json-metadata-to-struct

laverya · web-flow · commit 96a0fc212c61 · 2018-10-11T17:08:12.000-07:00
ship metadata should be a struct not a map[string]string
diff --git a/integration/base/conditional-asset/expected/.ship/state.json b/integration/base/conditional-asset/expected/.ship/state.json
@@ -6,8 +6,6 @@
     "contentSHA": "e935ace16aacb22dc0fc5eccb3e7cc44c25ae8ffeca805c434317449d595800a",
     "metadata": {
       "applicationType": "replicated.app",
-      "customerID": "",
-      "installationID": "",
       "releaseNotes": "",
       "version": ""
     }
diff --git a/integration/base/docker-push/expected/.ship/state.json b/integration/base/docker-push/expected/.ship/state.json
@@ -7,8 +7,6 @@
     "contentSHA": "f1a562de29d7dbb760c9d20382613a47bff882ecf71f21ad5f1c67bbffa9fedd",
     "metadata": {
       "applicationType": "replicated.app",
-      "customerID": "",
-      "installationID": "",
       "releaseNotes": "",
       "version": ""
     }
diff --git a/integration/base/helm-fetch/expected/.ship/state.json b/integration/base/helm-fetch/expected/.ship/state.json
@@ -4,8 +4,6 @@
     "contentSHA": "54e761100cb39926d58cb68ddc20437347240310f5cbdce01f00d7e085d4c2b1",
     "metadata": {
       "applicationType": "replicated.app",
-      "customerID": "",
-      "installationID": "",
       "releaseNotes": "",
       "version": ""
     }
diff --git a/integration/base/render-root/expected/.ship/state.json b/integration/base/render-root/expected/.ship/state.json
@@ -4,8 +4,6 @@
     "contentSHA": "43908c014adbcd9b9c7bd5eb548fc5086c7a9f85b009c70a16e2902097d73784",
     "metadata": {
       "applicationType": "replicated.app",
-      "customerID": "",
-      "installationID": "",
       "releaseNotes": "",
       "version": ""
     }
diff --git a/integration/init/git-root-directory/expected/.ship/state.json b/integration/init/git-root-directory/expected/.ship/state.json
@@ -6,7 +6,6 @@
     "upstream": "https://github.com/replicatedhq/test-chart-root-dir/tree/507feecae588c958ebe82bcf701b8be63f34ac9b/",
     "metadata": {
       "applicationType": "helm",
-      "icon": "",
       "name": "values-update",
       "releaseNotes": "test chart",
       "version": "0.1.0"
diff --git a/integration/update/basic/expected/.ship/state.json b/integration/update/basic/expected/.ship/state.json
@@ -14,7 +14,6 @@
     },
     "metadata": {
       "applicationType": "helm",
-      "icon": "",
       "name": "basic",
       "releaseNotes": "Update README.md",
       "version": "0.1.0"
diff --git a/integration/update/modify-chart/expected/.ship/state.json b/integration/update/modify-chart/expected/.ship/state.json
@@ -14,7 +14,6 @@
     },
     "metadata": {
       "applicationType": "helm",
-      "icon": "",
       "name": "modify-chart",
       "releaseNotes": "Update values.yaml",
       "version": "0.1.0"
diff --git a/integration/update/values-static/expected/.ship/state.json b/integration/update/values-static/expected/.ship/state.json
@@ -14,7 +14,6 @@
     },
     "metadata": {
       "applicationType": "helm",
-      "icon": "",
       "name": "values-update",
       "releaseNotes": "add static chart (will not be updated)",
       "version": "0.1.0"
diff --git a/pkg/state/manager.go b/pkg/state/manager.go
@@ -77,12 +77,12 @@ func (m *MManager) SerializeShipMetadata(metadata api.ShipAppMetadata, applicati
 	}
 
 	versionedState := current.Versioned()
-	versionedState.V1.Metadata = map[string]string{
-		"applicationType": applicationType,
-		"releaseNotes":    metadata.ReleaseNotes,
-		"version":         metadata.Version,
-		"icon":            metadata.Icon,
-		"name":            metadata.Name,
+	versionedState.V1.Metadata = &Metadata{
+		ApplicationType: applicationType,
+		ReleaseNotes:    metadata.ReleaseNotes,
+		Version:         metadata.Version,
+		Icon:            metadata.Icon,
+		Name:            metadata.Name,
 	}
 
 	return m.serializeAndWriteState(versionedState)
@@ -99,12 +99,12 @@ func (m *MManager) SerializeAppMetadata(metadata api.ReleaseMetadata) error {
 	}
 
 	versionedState := current.Versioned()
-	versionedState.V1.Metadata = map[string]string{
-		"applicationType": "replicated.app",
-		"releaseNotes":    metadata.ReleaseNotes,
-		"customerID":      metadata.CustomerID,
-		"installationID":  metadata.InstallationID,
-		"version":         metadata.Semver,
+	versionedState.V1.Metadata = &Metadata{
+		ApplicationType: "replicated.app",
+		ReleaseNotes:    metadata.ReleaseNotes,
+		Version:         metadata.Semver,
+		CustomerID:      metadata.CustomerID,
+		InstallationID:  metadata.InstallationID,
 	}
 
 	return m.serializeAndWriteState(versionedState)
diff --git a/pkg/state/manager_test.go b/pkg/state/manager_test.go
@@ -429,12 +429,12 @@ func TestMManager_SerializeShipMetadata(t *testing.T) {
 			},
 			expected: VersionedState{
 				V1: &V1{
-					Metadata: map[string]string{
-						"applicationType": "mock application type",
-						"releaseNotes":    "",
-						"version":         "test version",
-						"icon":            "test icon",
-						"name":            "test name",
+					Metadata: &Metadata{
+						ApplicationType: "mock application type",
+						ReleaseNotes:    "",
+						Version:         "test version",
+						Icon:            "test icon",
+						Name:            "test name",
 					},
 				},
 			},
diff --git a/pkg/state/models.go b/pkg/state/models.go
@@ -60,7 +60,7 @@ type V1 struct {
 	HelmValuesDefaults string                 `json:"helmValuesDefaults,omitempty" yaml:"helmValuesDefaults,omitempty" hcl:"helmValuesDefaults,omitempty"`
 	Kustomize          *Kustomize             `json:"kustomize,omitempty" yaml:"kustomize,omitempty" hcl:"kustomize,omitempty"`
 	Upstream           string                 `json:"upstream,omitempty" yaml:"upstream,omitempty" hcl:"upstream,omitempty"`
-	Metadata           map[string]string      `json:"metadata" yaml:"metadata" hcl:"metadata"`
+	Metadata           *Metadata              `json:"metadata" yaml:"metadata" hcl:"metadata"`
 	//deprecated in favor of upstream
 	ChartURL     string    `json:"chartURL,omitempty" yaml:"chartURL,omitempty" hcl:"chartURL,omitempty"`
 	ChartRepoURL string    `json:"ChartRepoURL,omitempty" yaml:"ChartRepoURL,omitempty" hcl:"ChartRepoURL,omitempty"`
@@ -69,6 +69,16 @@ type V1 struct {
 	Lifecycle    *Lifeycle `json:"lifecycle,omitempty" yaml:"lifecycle,omitempty" hcl:"lifecycle,omitempty"`
 }
 
+type Metadata struct {
+	ApplicationType string `json:"applicationType" yaml:"applicationType" hcl:"applicationType"`
+	Icon            string `json:"icon,omitempty" yaml:"icon,omitempty" hcl:"icon,omitempty"`
+	Name            string `json:"name,omitempty" yaml:"name,omitempty" hcl:"name,omitempty"`
+	ReleaseNotes    string `json:"releaseNotes" yaml:"releaseNotes" hcl:"releaseNotes"`
+	Version         string `json:"version" yaml:"version" hcl:"version"`
+	CustomerID      string `json:"customerID,omitempty" yaml:"customerID,omitempty" hcl:"customerID,omitempty"`
+	InstallationID  string `json:"installationID,omitempty" yaml:"installationID,omitempty" hcl:"installationID,omitempty"`
+}
+
 type StepsCompleted map[string]interface{}
 
 func (s StepsCompleted) String() string {

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,6 @@`
`6`	`6`	`"contentSHA": "e935ace16aacb22dc0fc5eccb3e7cc44c25ae8ffeca805c434317449d595800a",`
`7`	`7`	`"metadata": {`
`8`	`8`	`"applicationType": "replicated.app",`
`9`		`- "customerID": "",`
`10`		`- "installationID": "",`
`11`	`9`	`"releaseNotes": "",`
`12`	`10`	`"version": ""`
`13`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,6 @@`
`7`	`7`	`"contentSHA": "f1a562de29d7dbb760c9d20382613a47bff882ecf71f21ad5f1c67bbffa9fedd",`
`8`	`8`	`"metadata": {`
`9`	`9`	`"applicationType": "replicated.app",`
`10`		`- "customerID": "",`
`11`		`- "installationID": "",`
`12`	`10`	`"releaseNotes": "",`
`13`	`11`	`"version": ""`
`14`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,6 @@`
`4`	`4`	`"contentSHA": "54e761100cb39926d58cb68ddc20437347240310f5cbdce01f00d7e085d4c2b1",`
`5`	`5`	`"metadata": {`
`6`	`6`	`"applicationType": "replicated.app",`
`7`		`- "customerID": "",`
`8`		`- "installationID": "",`
`9`	`7`	`"releaseNotes": "",`
`10`	`8`	`"version": ""`
`11`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,6 @@`
`4`	`4`	`"contentSHA": "43908c014adbcd9b9c7bd5eb548fc5086c7a9f85b009c70a16e2902097d73784",`
`5`	`5`	`"metadata": {`
`6`	`6`	`"applicationType": "replicated.app",`
`7`		`- "customerID": "",`
`8`		`- "installationID": "",`
`9`	`7`	`"releaseNotes": "",`
`10`	`8`	`"version": ""`
`11`	`9`	`}`