Add docker, nomad and k8s manifests for exporter

.github/workflows/docker-integration-test.yaml

@@ -0,0 +1,31 @@
+name: docker-integration-test
+on: [push]
+jobs:
+  docker-integration-test:
+    runs-on: ubuntu-latest
+    steps:
+      - 
+        name: Checkout code
+        uses: actions/checkout@v3
+      - 
+        name: Go build
+        run: CGO_ENABLED=0 GOOS=linux go build -o grid-intensity .
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Docker build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          load: true
+          tags: thegreenwebfoundation/grid-intensity:integration-test
+      -
+        name: Docker run
+        run: docker run -d -e GRID_INTENSITY_REGION=GBR -p 8000:8000 thegreenwebfoundation/grid-intensity:integration-test exporter
+      - 
+        name: Run integration test
+        run: go test -v -tags=dockerrequired ./integration/test/exporter

.github/workflows/kubernetes-integration-test.yaml

@@ -0,0 +1,49 @@
+name: kubernetes-integration-test
+on: [push]
+jobs:
+  kubernetes-integration-test:
+    runs-on: ubuntu-latest
+    steps:
+      - 
+        name: Checkout code
+        uses: actions/checkout@v3
+      - 
+        name: Go build
+        run: CGO_ENABLED=0 GOOS=linux go build -o grid-intensity .
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Docker build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          load: true
+          tags: thegreenwebfoundation/grid-intensity:integration-test
+      - 
+        name: Create kubernetes Kind Cluster
+        uses: helm/[email protected]
+      - 
+        name: Load image into Kind cluster
+        run: kind load docker-image --name chart-testing thegreenwebfoundation/grid-intensity:integration-test
+      - 
+        name: Set up Helm
+        uses: azure/setup-helm@v3
+      - 
+        name: Helm install
+        run: helm install grid-intensity-exporter helm/grid-intensity-exporter --set image.tag=integration-test
+      - 
+        name: Set up Kubectl
+        uses: azure/setup-kubectl@v3
+      - 
+        name: Wait for ready pod
+        run: kubectl wait --for=condition=ready -l app.kubernetes.io/name=grid-intensity-exporter pod
+      - 
+        name: Create port forward to metrics port
+        run: kubectl port-forward deployment/grid-intensity-exporter 8000:8000 &
+      - 
+        name: Run integration test
+        run: go test -v -tags=dockerrequired ./integration/test/exporter

.github/workflows/nomad-integration-test.yaml

@@ -0,0 +1,43 @@
+name: nomad-integration-test
+on: [push]
+jobs:
+  nomad-integration-test:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout code
+        uses: actions/checkout@v3
+      -
+        name: Go build
+        run: CGO_ENABLED=0 GOOS=linux go build -o grid-intensity .
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Docker build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          load: true
+          tags: thegreenwebfoundation/grid-intensity:integration-test
+      -
+        name: Add HashiCorp GPG key
+        run: curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
+      -
+        name: Add HashiCorp Linux repository
+        run: sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
+      -
+        name: Install nomad
+        run: sudo apt-get update && sudo apt-get install nomad
+      -
+        name: Start running nomad in agent mode, then background it
+        run: nomad agent --dev &
+      -
+        name: Submit the grid-intensity-exporter.nomad job to nomad
+        run: nomad run ./nomad/grid-intensity-exporter.nomad
+      -
+        name: Run integration test
+        run: go test -v -tags=dockerrequired ./integration/test/exporter

.gitignore

@@ -13,5 +13,8 @@
 
 dist/
 
+grid-intensity
+grid-intenity-go
+
 # Dependency directories (remove the comment below to include it)
 # vendor/

Dockerfile

@@ -0,0 +1,9 @@
+FROM alpine:3.16
+
+RUN apk add --no-cache ca-certificates
+
+ADD ./grid-intensity /grid-intensity
+
+EXPOSE 8000/tcp
+
+ENTRYPOINT ["/grid-intensity"]

cmd/config.go

@@ -0,0 +1,91 @@
+package cmd
+
+import (
+	"errors"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/viper"
+)
+
+const (
+	electricityMapAPITokenEnvVar = "ELECTRICITY_MAP_API_TOKEN"
+	wattTimeUserEnvVar           = "WATT_TIME_USER"
+	wattTimePasswordEnvVar       = "WATT_TIME_PASSWORD"
+)
+
+func getConfigFile() (string, error) {
+	homeDir, err := os.UserHomeDir()
+	if err != nil {
+		return "", nil
+	}
+
+	return filepath.Join(homeDir, configDir, configFileName), nil
+}
+
+func configFileExists(configFile string) (bool, error) {
+	_, err := os.Stat(configFile)
+	if err == nil {
+		return true, nil
+	}
+	if errors.Is(err, os.ErrNotExist) {
+		return false, nil
+	}
+
+	return false, err
+}
+
+func readConfig() (string, string, error) {
+	configFile, err := getConfigFile()
+	if err != nil {
+		return "", "", err
+	}
+
+	viper.SetConfigFile(configFile)
+
+	err = viper.ReadInConfig()
+	if errors.Is(err, os.ErrNotExist) {
+		// Config file may not be available e.g. when running as a container.
+	} else if err != nil {
+		return "", "", err
+	}
+
+	providerName := viper.GetString(provider)
+	regionCode := viper.GetString(region)
+
+	return providerName, regionCode, nil
+}
+
+func writeConfig() error {
+	configFile, err := getConfigFile()
+	if err != nil {
+		return err
+	}
+
+	fileExists, err := configFileExists(configFile)
+	if err != nil {
+		return err
+	}
+
+	if !fileExists {
+		// Create config dir if it doesn't exist.
+		err = os.MkdirAll(filepath.Dir(configFile), os.ModePerm)
+		if err != nil && !os.IsExist(err) {
+			return nil
+		}
+
+		// Create config file if it doesn't exist.
+		_, err = os.Create(configFile)
+		if err != nil {
+			// If we can't create file don't try to write config.
+			return nil
+		}
+	}
+
+	err = viper.WriteConfig()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

cmd/exporter.go

@@ -11,7 +11,6 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
 
 	gridintensity "github.com/thegreenwebfoundation/grid-intensity-go/api"
 	"github.com/thegreenwebfoundation/grid-intensity-go/carbonintensity"
@@ -229,7 +228,7 @@ func (e *Exporter) Describe(ch chan<- *prometheus.Desc) {
 }
 
 func runExporter() error {
-	providerName, regionCode, err := getConfig()
+	providerName, regionCode, err := readConfig()
 	if err != nil {
 		return err
 	}
@@ -239,7 +238,7 @@ func runExporter() error {
 		return err
 	}
 
-	err = viper.WriteConfig()
+	err = writeConfig()
 	if err != nil {
 		return err
 	}

cmd/root.go

@@ -61,6 +61,11 @@ func init() {
 
 	viper.BindPFlag(provider, rootCmd.PersistentFlags().Lookup(provider))
 	viper.BindPFlag(region, rootCmd.PersistentFlags().Lookup(region))
+
+	// Also support environment variables.
+	viper.SetEnvPrefix("grid_intensity")
+	viper.BindEnv(provider)
+	viper.BindEnv(region)
 }
 
 func getEmberGridIntensityForCountry(countryCode string) error {
@@ -143,7 +148,7 @@ func getCountryCode() (string, error) {
 func runRoot() error {
 	ctx := context.Background()
 
-	providerName, regionCode, err := getConfig()
+	providerName, regionCode, err := readConfig()
 	if err != nil {
 		return err
 	}
@@ -172,7 +177,7 @@ func runRoot() error {
 		return fmt.Errorf("provider %q not recognized", providerName)
 	}
 
-	err = viper.WriteConfig()
+	err = writeConfig()
 	if err != nil {
 		return err
 	}

go.mod

@@ -4,6 +4,7 @@ go 1.17
 
 require (
 	github.com/Xuanwo/go-locale v1.1.0
+	github.com/cenkalti/backoff/v4 v4.1.3
 	github.com/gofrs/flock v0.8.1
 	github.com/jellydator/ttlcache/v2 v2.11.1
 	github.com/prometheus/client_golang v1.12.2

go.sum

@@ -49,6 +49,8 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
+github.com/cenkalti/backoff/v4 v4.1.3 h1:cFAlzYUlVYDysBEH2T5hyJZMh3+5+WCBvSnK6Q8UtC4=
+github.com/cenkalti/backoff/v4 v4.1.3/go.mod h1:scbssz8iZGpm3xbr14ovlUdkxfGXNInqkPWOWmG2CLw=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/cespare/xxhash/v2 v2.1.2 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE=

helm/grid-intensity-exporter/Chart.yaml

@@ -0,0 +1,5 @@
+apiVersion: "v1"
+description: "A prometheus exporter for understanding the carbon intensity of compute."
+home: "https://github.com/thegreenwebfoundation/grid-intensity-go"
+name: "grid-intensity-exporter"
+version: "0.1.0"

helm/grid-intensity-exporter/templates/configmap.yaml

@@ -0,0 +1,9 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ .Release.Name }}
+  labels:
+    app.kubernetes.io/name: {{ .Release.Name }}
+data:
+  gridIntensityProvider: {{ .Values.gridIntensity.provider | quote }}
+  gridIntensityRegion: {{ .Values.gridIntensity.region | quote }}