Merge pull request openshift#214 from jeefy/SDCICD-129

SDCICD-129: Update metadata json file upon every metadata instance change

Author: openshift-merge-robot

common/e2e.go

@@ -59,7 +59,7 @@ func RunE2ETests(t *testing.T) {
 			t.Fatalf("could not setup OSD: %v", err)
 		}
 
-		metadata.Instance.Environment = cfg.OCM.Env
+		metadata.Instance.SetEnvironment(cfg.OCM.Env)
 
 		// check that enough quota exists for this test if creating cluster
 		if len(state.Cluster.ID) == 0 {

common/setup.go

@@ -119,8 +119,8 @@ func setupCluster() (err error) {
 		}
 	}
 
-	metadata.Instance.ClusterName = state.Cluster.Name
-	metadata.Instance.ClusterID = state.Cluster.ID
+	metadata.Instance.SetClusterName(state.Cluster.Name)
+	metadata.Instance.SetClusterID(state.Cluster.ID)
 
 	if err = OSD.WaitForClusterReady(); err != nil {
 		return fmt.Errorf("failed waiting for cluster ready: %v", err)

common/version.go

@@ -30,8 +30,8 @@ func ChooseVersions(osd *osd.OSD) (err error) {
 	}
 
 	// Set the versions in metadata. If upgrade hasn't been chosen, it should still be omitted from the end result.
-	metadata.Instance.ClusterVersion = state.Cluster.Name
-	metadata.Instance.UpgradeVersion = state.Upgrade.ReleaseName
+	metadata.Instance.SetClusterVersion(state.Cluster.Version)
+	metadata.Instance.SetUpgradeVersion(state.Upgrade.ReleaseName)
 
 	return err
 }
@@ -110,7 +110,7 @@ func setupUpgradeVersion(osd *osd.OSD) (err error) {
 		if cisUpgradeVersion.GreaterThan(clusterVersion) {
 			log.Printf("Using cluster image set.")
 			state.Upgrade.ReleaseName = cisUpgradeVersionString
-			metadata.Instance.UpgradeVersionSource = "cluster image set"
+			metadata.Instance.SetUpgradeVersionSource("cluster image set")
 			log.Printf("Selecting version '%s' to be able to upgrade to '%s'", state.Cluster.Version, state.Upgrade.ReleaseName)
 			return nil
 		}

pkg/metadata/metadata.go

@@ -5,6 +5,8 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+
+	"github.com/openshift/osde2e/pkg/config"
 )
 
 const (
@@ -40,6 +42,58 @@ func init() {
 	Instance = &Metadata{}
 }
 
+// Next are a bunch of setter functions that allow us
+// to track/trap changes to metadata and then flush
+// the changes to a file.
+
+// SetClusterID sets the cluster id
+func (m *Metadata) SetClusterID(id string) {
+	m.ClusterID = id
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetClusterName sets the cluster name
+func (m *Metadata) SetClusterName(name string) {
+	m.ClusterName = name
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetClusterVersion sets the cluster version
+func (m *Metadata) SetClusterVersion(version string) {
+	m.ClusterVersion = version
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetEnvironment sets the cluster environment
+func (m *Metadata) SetEnvironment(env string) {
+	m.Environment = env
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetUpgradeVersion sets the cluster upgrade version
+func (m *Metadata) SetUpgradeVersion(ver string) {
+	m.UpgradeVersion = ver
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetUpgradeVersionSource sets the cluster upgrade version source
+func (m *Metadata) SetUpgradeVersionSource(src string) {
+	m.UpgradeVersionSource = src
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetTimeToOCMReportingInstalled sets the time it took for OCM to report a cluster provisioned
+func (m *Metadata) SetTimeToOCMReportingInstalled(timeToOCMReportingInstalled float64) {
+	m.TimeToOCMReportingInstalled = timeToOCMReportingInstalled
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
+// SetTimeToClusterReady sets the time it took for OCM to report a cluster ready
+func (m *Metadata) SetTimeToClusterReady(timeToClusterReady float64) {
+	m.TimeToClusterReady = timeToClusterReady
+	m.WriteToJSON(config.Instance.ReportDir)
+}
+
 // WriteToJSON will marshall the metadata struct and write it into the given file.
 func (m *Metadata) WriteToJSON(reportDir string) (err error) {
 	var data []byte

pkg/osd/cluster.go

@@ -188,15 +188,15 @@ func (u *OSD) WaitForClusterReady() error {
 				// This is the first time that we've entered this section, so we'll consider this the time until OCM has said the cluster is ready
 				if !ocmReady {
 					ocmReady = true
-					metadata.Instance.TimeToOCMReportingInstalled = time.Since(clusterStarted).Seconds()
+					metadata.Instance.SetTimeToOCMReportingInstalled(time.Since(clusterStarted).Seconds())
 					readinessStarted = time.Now()
 				}
 				if success, err := u.PollClusterHealth(); success {
 					cleanRuns++
 					log.Printf("Clean run %d/%d...", cleanRuns, cleanRunWindow)
 					errRuns = 0
 					if cleanRuns == cleanRunWindow {
-						metadata.Instance.TimeToClusterReady = time.Since(readinessStarted).Seconds()
+						metadata.Instance.SetTimeToClusterReady(time.Since(readinessStarted).Seconds())
 						return true, nil
 					}
 					return false, nil

pkg/upgrade/releases.go

@@ -47,13 +47,13 @@ func LatestRelease(releaseStream string, useReleaseControllerForInt bool) (name,
 			return "", "", fmt.Errorf("error decoding body of '%s': %v", data, err)
 		}
 
-		metadata.Instance.UpgradeVersionSource = "release controller"
+		metadata.Instance.SetUpgradeVersionSource("release controller")
 
 		return ensureReleasePrefix(latest.Name), latest.PullSpec, nil
 	}
 
 	log.Printf("Using Cincinnati.")
-	metadata.Instance.UpgradeVersionSource = "cincinnati"
+	metadata.Instance.SetUpgradeVersionSource("cincinnati")
 
 	// If stage or prod, use Cincinnati instead of the release controller
 	cincinnatiFormattedURL := fmt.Sprintf(cincinnatiURLFmt, osd.Environments.Choose(env), releaseStream)