test: integration build the ignite binary (#2639)

* test: integration build the ignite binary (WIP)

Previously, the ignite binary was supposed to be present in the path,
which can be error prone if the binary is not up to date with the
integration version.

The change builds the binary before the integration are run, using a
init() function. This is not very adequate since the binary is not
removed at the end of the test. To be able to remove it at the end of
the tests we could:

1) add a TestMain in each integration sub-package: not super fan of this
   because it involves to repeat the same code for each package
2) move all tests in the same package: preferable but delete the
   separation between the tests.

* test: constant ignite binary location

Also:
- use sync.Once rather than init() func
- use gocmd rather than exec.Command directly

* chore: no longer need to build the binary in gh action

* change cl section

Co-authored-by: Alex Johnson <alex@shmeeload.xyz>

Author: tbruyelle

.github/workflows/test-integration.yml

@@ -49,9 +49,6 @@ jobs:
         if: env.GIT_DIFF
         with:
           go-version: 1.19
-      - name: Install Ignite CLI
-        if: env.GIT_DIFF
-        run: go install ./...
       - name: Run Integration Tests
         if: env.GIT_DIFF
         run: go test -v -timeout 60m ./integration/${{ matrix.test-path }}

changelog.md

@@ -4,6 +4,7 @@
 
 ### Changes
 
+- Integration tests build their own ignite binary.
 - Updated `pkg/cosmosanalysis` to discover the list of app modules when defined in variables.
 - Switch to broadcast mode sync in `cosmosclient`
 - Updated `nodetime`: `ts-proto` to `v1.123.0`, `protobufjs` to `v7.1.1`, `swagger-typescript-api` to `v9.2.0`

integration/env.go

@@ -6,9 +6,11 @@ import (
 	"flag"
 	"fmt"
 	"os"
+	"path"
 	"path/filepath"
 	"strconv"
 	"strings"
+	"sync"
 	"testing"
 	"time"
 
@@ -17,17 +19,25 @@ import (
 
 	"github.com/ignite/cli/ignite/chainconfig"
 	"github.com/ignite/cli/ignite/pkg/cosmosfaucet"
+	"github.com/ignite/cli/ignite/pkg/gocmd"
+	"github.com/ignite/cli/ignite/pkg/gomodulepath"
 	"github.com/ignite/cli/ignite/pkg/httpstatuschecker"
-	"github.com/ignite/cli/ignite/pkg/xexec"
 	"github.com/ignite/cli/ignite/pkg/xurl"
 )
 
 const (
-	IgniteApp = "ignite"
-	Stargate  = "stargate"
+	ConfigYML = "config.yml"
 )
 
-var isCI, _ = strconv.ParseBool(os.Getenv("CI"))
+var (
+	// IgniteApp hold the location of the ignite binary used in the integration
+	// tests. The binary is compiled the first time the env.New() function is
+	// invoked.
+	IgniteApp = path.Join(os.TempDir(), "ignite-tests", "ignite")
+
+	isCI, _           = strconv.ParseBool(os.Getenv("CI"))
+	compileBinaryOnce sync.Once
+)
 
 // Env provides an isolated testing environment and what's needed to
 // make it possible.
@@ -44,12 +54,29 @@ func New(t *testing.T) Env {
 		ctx: ctx,
 	}
 	t.Cleanup(cancel)
+	compileBinaryOnce.Do(func() {
+		compileBinary(ctx)
+	})
+	return e
+}
 
-	if !xexec.IsCommandAvailable(IgniteApp) {
-		t.Fatal("ignite needs to be installed")
+func compileBinary(ctx context.Context) {
+	wd, err := os.Getwd()
+	if err != nil {
+		panic(fmt.Sprintf("unable to get working dir: %v", err))
+	}
+	_, appPath, err := gomodulepath.Find(wd)
+	if err != nil {
+		panic(fmt.Sprintf("unable to read go module path: %v", err))
+	}
+	var (
+		output, binary = filepath.Split(IgniteApp)
+		path           = path.Join(appPath, "ignite", "cmd", "ignite")
+	)
+	err = gocmd.BuildPath(ctx, output, binary, path, nil)
+	if err != nil {
+		panic(fmt.Sprintf("error while building binary: %v", err))
 	}
-
-	return e
 }
 
 func (e Env) T() *testing.T {