E2E: Move e2e mage targets to new package (#1404)

Author: toddtreece

build/common.go

@@ -21,11 +21,6 @@ import (
 
 	"github.com/grafana/grafana-plugin-sdk-go/build/info"
 	"github.com/grafana/grafana-plugin-sdk-go/build/utils"
-	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e"
-	ca "github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/certificate_authority"
-	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/config"
-	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/fixture"
-	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/storage"
 	"github.com/grafana/grafana-plugin-sdk-go/internal"
 )
 
@@ -446,60 +441,6 @@ func Clean() error {
 	return nil
 }
 
-// E2E is a namespace.
-type E2E mg.Namespace
-
-// Append starts the E2E proxy in append mode.
-func (E2E) Append() error {
-	return e2eProxy(e2e.ProxyModeAppend)
-}
-
-// Overwrite starts the E2E proxy in overwrite mode.
-func (E2E) Overwrite() error {
-	return e2eProxy(e2e.ProxyModeOverwrite)
-}
-
-// Replay starts the E2E proxy in replay mode.
-func (E2E) Replay() error {
-	return e2eProxy(e2e.ProxyModeReplay)
-}
-
-// Certificate prints the CA certificate to stdout.
-func (E2E) Certificate() error {
-	cfg, err := config.LoadConfig("proxy.json")
-	if err != nil {
-		return err
-	}
-
-	if cert, _, err := ca.LoadKeyPair(cfg.CAConfig.Cert, cfg.CAConfig.PrivateKey); err == nil {
-		fmt.Print(string(cert))
-		return nil
-	}
-
-	fmt.Print(string(ca.CACertificate))
-	return nil
-}
-
-func e2eProxy(mode e2e.ProxyMode) error {
-	cfg, err := config.LoadConfig("proxy.json")
-	if err != nil {
-		return err
-	}
-	fixtures := make([]*fixture.Fixture, 0)
-	for _, s := range cfg.Storage {
-		switch s.Type {
-		case config.StorageTypeHAR:
-			store := storage.NewHARStorage(s.Path)
-			fixtures = append(fixtures, fixture.NewFixture(store))
-		case config.StorageTypeOpenAPI:
-			store := storage.NewOpenAPIStorage(s.Path)
-			fixtures = append(fixtures, fixture.NewFixture(store))
-		}
-	}
-	proxy := e2e.NewProxy(mode, fixtures, cfg)
-	return proxy.Start()
-}
-
 // checkLinuxPtraceScope verifies that ptrace is configured as required.
 func checkLinuxPtraceScope() error {
 	ptracePath := "/proc/sys/kernel/yama/ptrace_scope"

experimental/e2e/README.md

@@ -38,20 +38,33 @@ The goal of the proxy is to provide a way to record and replay HTTP interactions
 
 2. Add the proxy's CA certificate to your environment ([instructions](#ca-certificate-setup)).
 
-3. Start proxy using one of the [commands listed below](#mage-commands). For example:
+3. Add the E2E mage targets to your `Magefile.go` imports.
 
+```diff
+package main
+ 
+import (
+	// mage:import
+	build "github.com/grafana/grafana-plugin-sdk-go/build"
++	// mage:import
++	_ "github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/mage"
+)
 ```
+
+4. Start proxy using one of the [commands listed below](#mage-commands). For example:
+
+```bash
 mage e2e:append
 ```
 
-4. Point Grafana at the proxy by exporting the `HTTP_PROXY` and `HTTPS_PROXY` environment variables:
+5. Point Grafana at the proxy by exporting the `HTTP_PROXY` and `HTTPS_PROXY` environment variables:
 
-```
+```bash
 export HTTP_PROXY=127.0.0.1:9999
 export HTTPS_PROXY=127.0.0.1:9999
 ```
 
-5. Start Grafana
+6. Start Grafana
 
 **Note:** Only queries with **absolute time ranges** should be used with the proxy. Relative time ranges are not supported in the default matcher.
 
@@ -63,27 +76,27 @@ This step is needed so that the proxy can intercept HTTPS traffic. By default, t
 
 1. Add CA certificate:
 
-```
+```bash
 mage e2e:certificate && sudo tee /usr/share/ca-certificates/extra/ca.crt
 ```
 
 2. Update the CA store:
 
-```
+```bash
 sudo update-ca-certificates --fresh
 ```
 
 ### MacOS
 
 1. Create a temporary copy of the CA certificate:
 
-```
+```bash
 mage e2e:certificate > /tmp/grafana-e2e.crt
 ```
 
 2. Add CA certificate:
 
-```
+```bash
 sudo security add-trusted-cert -d -p ssl -p basic -k /Library/Keychains/System.keychain /tmp/grafana-e2e.crt
 ```
 
@@ -186,31 +199,31 @@ Example configuration:
 
 Append mode should be used to record interactions for any new tests. It will record requests and responses for any requests that haven't been seen before, and return recorded responses for any requests that match previously recorded interactions.
 
-```
+```bash
 mage e2e:append
 ```
 
 ### Overwrite mode
 
 Overwrite mode should be used if previously recorded interactions need to be replaced with new data.
 
-```
+```bash
 mage e2e:overwrite
 ```
 
 ### Replay mode
 
 Replay mode should be used in CI or locally if only playback of recorded data is needed. Replay mode will return recorded responses for any matching requests, and pass any requests that don't match recorded interactions to the target API.
 
-```
+```bash
 mage e2e:replay
 ```
 
 ### CA Certificate
 
 This command prints the CA certificate to stdout so that it can be added to the local test environment. For more information, see the [CA Setup](#ca-certificate-setup) section above.
 
-```
+```bash
 mage e2e:certificate
 ```
 
@@ -300,7 +313,7 @@ func CustomE2E() error {
 
 Start the proxy using the new `CustomE2E` mage target:
 
-```
+```bash
 mage CustomE2E
 ```
 

experimental/e2e/mage/e2e.go

@@ -0,0 +1,66 @@
+package mage
+
+import (
+	"fmt"
+
+	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e"
+	ca "github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/certificate_authority"
+	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/config"
+	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/fixture"
+	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/storage"
+	"github.com/magefile/mage/mg"
+)
+
+// E2e is a namespace.
+type E2e mg.Namespace
+
+// Append starts the E2E proxy in append mode.
+func (E2e) Append() error {
+	return e2eProxy(e2e.ProxyModeAppend)
+}
+
+// Overwrite starts the E2E proxy in overwrite mode.
+func (E2e) Overwrite() error {
+	return e2eProxy(e2e.ProxyModeOverwrite)
+}
+
+// Replay starts the E2E proxy in replay mode.
+func (E2e) Replay() error {
+	return e2eProxy(e2e.ProxyModeReplay)
+}
+
+// Certificate prints the CA certificate to stdout.
+func (E2e) Certificate() error {
+	cfg, err := config.LoadConfig("proxy.json")
+	if err != nil {
+		return err
+	}
+
+	if cert, _, err := ca.LoadKeyPair(cfg.CAConfig.Cert, cfg.CAConfig.PrivateKey); err == nil {
+		fmt.Print(string(cert))
+		return nil
+	}
+
+	fmt.Print(string(ca.CACertificate))
+	return nil
+}
+
+func e2eProxy(mode e2e.ProxyMode) error {
+	cfg, err := config.LoadConfig("proxy.json")
+	if err != nil {
+		return err
+	}
+	fixtures := make([]*fixture.Fixture, 0)
+	for _, s := range cfg.Storage {
+		switch s.Type {
+		case config.StorageTypeHAR:
+			store := storage.NewHARStorage(s.Path)
+			fixtures = append(fixtures, fixture.NewFixture(store))
+		case config.StorageTypeOpenAPI:
+			store := storage.NewOpenAPIStorage(s.Path)
+			fixtures = append(fixtures, fixture.NewFixture(store))
+		}
+	}
+	proxy := e2e.NewProxy(mode, fixtures, cfg)
+	return proxy.Start()
+}