Added upgrade events to reporter (#224)

* Added upgrade events

* fix

* Added abrupt cancellation

* Changed event name

* Added support for more events

* bump

* small fix

* report finish

Author: danielm-codefresh

Makefile

@@ -1,4 +1,4 @@
-VERSION=v0.0.206
+VERSION=v0.0.207
 
 OUT_DIR=dist
 YEAR?=$(shell date +"%Y")

cmd/commands/runtime.go

@@ -42,8 +42,9 @@ func main() {
 	// configure autopilot logger
 	apu.ConfigureLoggerOrDie(c)
 
-	if err := c.ExecuteContext(ctx); err != nil {
-		reporter.G().Close()
+	err := c.ExecuteContext(ctx)
+	reporter.G().Close("", err)
+	if err != nil {
 		log.G(ctx).Fatal(err)
 	}
 }

cmd/main.go

@@ -23,7 +23,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.206/cf-linux-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.207/cf-linux-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-linux-amd64 /usr/local/bin/cf
@@ -36,7 +36,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.206/cf-darwin-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.207/cf-darwin-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-darwin-amd64 /usr/local/bin/cf

docs/releases/release_notes.md

@@ -5,7 +5,7 @@ metadata:
     namespace: '{{ namespace }}'
 spec:
     defVersion: 1.0.0
-    version: 0.0.206
+    version: 0.0.207
     bootstrapSpecifier: github.com/codefresh-io/cli-v2/manifests/argo-cd
     components:
         - name: events

manifests/runtime.yaml

@@ -27,7 +27,7 @@ var ar AnalyticsReporter = &noopAnalyticsReporter{}
 type (
 	AnalyticsReporter interface {
 		ReportStep(CliStepData)
-		Close()
+		Close(step CliStepStatus, err error)
 	}
 
 	CliStepData struct {
@@ -55,38 +55,83 @@ type (
 )
 
 const (
-	cliEvent string = "cli-runtime-operations"
+	cliEvent string = "csdp-cli"
 
 	// Install
-	InstallStepPreChecks                   CliStep = "install.pre-installation-checks"
-	InstallStepDownloadRuntimeDefinitions  CliStep = "install.download-runtime-definitions"
-	InstallStepGetServerAddress            CliStep = "install.get-server-address"
-	InstallStepCreateRuntimeOnPlatform     CliStep = "install.create-runtime-on-platform"
-	InstallStepBootstrapRepo               CliStep = "install.bootstrap-repo"
-	InstallStepCreateProject               CliStep = "install.create-project"
-	InstallStepCreateConfigMap             CliStep = "install.create-codefresh-cm"
-	InstallStepCreateComponent             CliStep = "install.create-component"
-	InstallStepInstallComponenets          CliStep = "install.install-components"
-	InstallStepCreateGitsource             CliStep = "install.create-gitsource"
-	InstallStepCreateMarketplaceGitsource  CliStep = "install.create-marketplace-gitsource"
-	InstallStepCompleteRuntimeInstallation CliStep = "install.complete-runtime-installation"
-	InstallStepCreateDefaultGitIntegration CliStep = "install.create-default-git-integration"
+	InstallPhasePreCheckStart                         CliStep = "install.pre-check.phase.start"
+	InstallStepPreCheckValidateRuntimeVersion         CliStep = "install.pre-check.step.validate-runtime-version"
+	InstallStepPreCheckGetRuntimeName                 CliStep = "install.pre-check.step.get-runtime-name"
+	InstallStepPreCheckRuntimeNameValidation          CliStep = "install.pre-check.step.runtime-name-validation"
+	InstallStepPreCheckGetKubeContext                 CliStep = "install.pre-check.step.get-kube-context"
+	InstallStepPreCheckEnsureRuntimeRepo              CliStep = "install.pre-check.step.ensure-runtime-repo"
+	InstallStepPreCheckEnsureGitToken                 CliStep = "install.pre-check.step.ensure-git-token"
+	InstallStepPreCheckEnsureIngressHost              CliStep = "install.pre-check.step.ensure-ingress-host"
+	InstallStepPreCheckShouldInstallDemoResources     CliStep = "install.pre-check.step.should-install-demo-resources"
+	InstallPhasePreCheckFinish                        CliStep = "install.pre-check.phase.finish"
+	InstallPhaseRunPreCheckStart                      CliStep = "install.run.pre-check.phase.start"
+	InstallStepRunPreCheckDownloadRuntimeDefinition   CliStep = "install.run.pre-check.step.download-runtime-definition"
+	InstallStepRunPreCheckEnsureCliVersion            CliStep = "install.run.pre-check.step.ensure-cli-version"
+	InstallStepRunPreCheckRuntimeCollision            CliStep = "install.run.pre-check.step.runtime-collision"
+	InstallStepRunPreCheckExisitingRuntimes           CliStep = "install.run.pre-check.step.existing-runtimes"
+	InstallStepRunPreCheckValidateClusterRequirements CliStep = "install.run.pre-check.step.validate-cluster-requirements"
+	InstallPhaseRunPreCheckFinish                     CliStep = "install.run.pre-check.phase.finish"
+	InstallPhaseStart                                 CliStep = "install.run.phase.start"
+	InstallStepDownloadRuntimeDefinition              CliStep = "install.run.step.download-runtime-definition"
+	InstallStepGetServerAddress                       CliStep = "install.run.step.get-server-address"
+	InstallStepCreateRuntimeOnPlatform                CliStep = "install.run.step.create-runtime-on-platform"
+	InstallStepBootstrapRepo                          CliStep = "install.run.step.bootstrap-repo"
+	InstallStepCreateProject                          CliStep = "install.run.step.create-project"
+	InstallStepCreateConfigMap                        CliStep = "install.run.step.create-codefresh-cm"
+	InstallStepCreateComponent                        CliStep = "install.run.step.create-component"
+	InstallStepInstallComponenets                     CliStep = "install.run.step.install-components"
+	InstallStepCreateGitsource                        CliStep = "install.run.step.create-gitsource"
+	InstallStepCreateMarketplaceGitsource             CliStep = "install.run.step.create-marketplace-gitsource"
+	InstallStepCompleteRuntimeInstallation            CliStep = "install.run.step.complete-runtime-installation"
+	InstallStepCreateDefaultGitIntegration            CliStep = "install.run.step.create-default-git-integration"
+	InstallPhaseFinish                                CliStep = "install.run.phase.finish"
 
 	// Uninstall
-	UninstallStepCheckRuntimeExists            CliStep = "uninstall.check-runtime-exists"
-	UninstallStepUninstallRepo                 CliStep = "uninstall.uninstall-repo"
-	UninstallStepDeleteRuntimeFromPlatform     CliStep = "uninstall.delete-runtime-from-platform"
-	UninstallStepCompleteRuntimeUninstallation CliStep = "uninstall.complete-runtime-uninstall"
+	UninstallPhasePreCheckStart                CliStep = "uninstall.pre-check.phase.start"
+	UninstallStepPreCheckGetKubeContext        CliStep = "uninstall.pre-check.step.get-kube-context"
+	UninstallStepPreCheckEnsureRuntimeName     CliStep = "uninstall.pre-check.step.ensure-runtime-name"
+	UninstallStepPreCheckRuntimeNameValidation CliStep = "uninstall.pre-check.step.runtime-name-validation"
+	UninstallStepPreCheckEnsureRuntimeRepo     CliStep = "uninstall.pre-check.step.ensure-runtime-repo"
+	UninstallStepPreCheckEnsureGitToken        CliStep = "uninstall.pre-check.step.ensure-git-token"
+	UninstallPhasePreCheckFinish               CliStep = "uninstall.pre-check.phase.finish"
+	UninstallPhaseStart                        CliStep = "uninstall.run.phase.start"
+	UninstallStepCheckRuntimeExists            CliStep = "uninstall.run.step.check-runtime-exists"
+	UninstallStepUninstallRepo                 CliStep = "uninstall.run.step.uninstall-repo"
+	UninstallStepDeleteRuntimeFromPlatform     CliStep = "uninstall.run.step.delete-runtime-from-platform"
+	UninstallPhaseFinish                       CliStep = "uninstall.run.phase.finish"
+
+	// Upgrade
+	UpgradePhasePreCheckStart              CliStep = "upgrade.pre-check.phase.start"
+	UpgradeStepPreCheckEnsureRuntimeName   CliStep = "upgrade.pre-check.step.ensure-runtime-name"
+	UpgradeStepPreCheckEnsureRuntimeRepo   CliStep = "upgrade.pre-check.step.ensure-runtime-repo"
+	UpgradeStepPreCheckEnsureGitToken      CliStep = "upgrade.pre-check.step.ensure-git-token"
+	UpgradePhasePreCheckFinish             CliStep = "upgrade.pre-check.phase.finish"
+	UpgradePhaseStart                      CliStep = "upgrade.run.phase.start"
+	UpgradeStepDownloadRuntimeDefinition   CliStep = "upgrade.run.step.download-runtime-definition"
+	UpgradeStepRunPreCheckEnsureCliVersion CliStep = "upgrade.run.step.ensure-cli-version"
+	UpgradeStepGetRepo                     CliStep = "upgrade.run.step.get-repo"
+	UpgradeStepLoadRuntimeDefinition       CliStep = "upgrade.run.step.load-runtime-definition"
+	UpgradeStepUpgradeRuntime              CliStep = "upgrade.run.step.upgrade-runtime"
+	UpgradeStepPushRuntimeDefinition       CliStep = "upgrade.run.step.push-runtime-definition"
+	UpgradeStepCreateApp                   CliStep = "upgrade.run.step.create-app"
+	UpgradePhaseFinish                     CliStep = "upgrade.run.phase.finish"
 
 	// General
 	SIGNAL_TERMINATION CliStep = "signal-termination"
+	FINISH             CliStep = "run.finish"
 
-	SUCCESS  CliStepStatus = "SUCCESS"
-	FAILURE  CliStepStatus = "FAILURE"
-	CANCELED CliStepStatus = "CANCELED"
+	SUCCESS           CliStepStatus = "SUCCESS"
+	FAILURE           CliStepStatus = "FAILURE"
+	CANCELED          CliStepStatus = "CANCELED"
+	ABRUPTLY_CANCELED CliStepStatus = "ABRUPTLY_CANCELED"
 
 	InstallFlow   FlowType = "installation"
 	UninstallFlow FlowType = "uninstallation"
+	UpgradeFlow   FlowType = "upgrade"
 )
 
 // G returns the global reporter
@@ -140,7 +185,23 @@ func (r *segmentAnalyticsReporter) ReportStep(data CliStepData) {
 	}
 }
 
-func (r *segmentAnalyticsReporter) Close() {
+func (r *segmentAnalyticsReporter) Close(status CliStepStatus, err error) {
+	if status == "" {
+		status = SUCCESS
+		if err != nil {
+			status = FAILURE
+		}
+	}
+
+	log.G().Infof("Closing with status %s", status)
+
+	r.ReportStep(CliStepData{
+		Step:        FINISH,
+		Status:      status,
+		Description: "Finished",
+		Err:         err,
+	})
+
 	if err := r.client.Close(); err != nil {
 		log.G().Debugf("Failed to close segment client: %w", err)
 	}
@@ -150,5 +211,5 @@ func (r *noopAnalyticsReporter) ReportStep(_ CliStepData) {
 	// If no segmentWriteKey is provided this reporter will be used instead.
 }
 
-func (r *noopAnalyticsReporter) Close() {
+func (r *noopAnalyticsReporter) Close(_ CliStepStatus, _ error) {
 }

pkg/reporter/reporter.go

@@ -54,17 +54,12 @@ func ContextWithCancelOnSignals(ctx context.Context, sigs ...os.Signal) context.
 		for {
 			s := <-sig
 			cancels++
-			reporter.G().ReportStep(reporter.CliStepData{
-				Step:        reporter.SIGNAL_TERMINATION,
-				Status:      reporter.CANCELED,
-				Description: "Cancelled by an external signal",
-				Err:         nil,
-			})
 			if cancels == 1 {
 				log.G(ctx).Printf("got signal: %s", s)
+				reportCancel(reporter.CANCELED)
 				cancel()
 			} else {
-				reporter.G().Close()
+				reporter.G().Close(reporter.ABRUPTLY_CANCELED, nil)
 				log.G(ctx).Printf("forcing exit")
 				os.Exit(1)
 			}
@@ -179,3 +174,12 @@ func CurrentServer() (string, error) {
 func DecorateErrorWithDocsLink(err error) error {
 	return fmt.Errorf("%s\nfor more information: %s", err.Error(), store.Get().DocsLink)
 }
+
+func reportCancel(status reporter.CliStepStatus) {
+	reporter.G().ReportStep(reporter.CliStepData{
+		Step:        reporter.SIGNAL_TERMINATION,
+		Status:      status,
+		Description: "Cancelled by an external signal",
+		Err:         nil,
+	})
+}