make independent of env vars

Author: hughesjj

Makefile

@@ -1,7 +1,8 @@
 include ./Makefile.Common
 include ./packaging/technical-addon/Makefile
-BUILD_DIR?=$(realpath .)
 ### VARIABLES
+SOURCE_DIR?=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+BUILD_DIR?=$(git rev-parse --show-toplevel)
 
 # BUILD_TYPE should be one of (dev, release).
 BUILD_TYPE?=release
@@ -11,7 +12,7 @@ GIT_SHA=$(shell git rev-parse --short HEAD)
 GOARCH=$(shell go env GOARCH)
 GOOS=$(shell go env GOOS)
 
-FIND_MOD_ARGS=-type f -name "go.mod"
+FIND_MOD_ARGS=-type f -name "go.mod"  -not -path "./packaging/technical-addon/*"
 TO_MOD_DIR=dirname {} \; | sort | egrep  '^./'
 
 ALL_MODS := $(shell find . $(FIND_MOD_ARGS) -exec $(TO_MOD_DIR)) $(PWD)

Makefile.Common

@@ -1,5 +1,6 @@
 # Explicitly define the shell we will use for commands.
 SHELL?=/bin/bash
+SOURCE_DIR?=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 BUILD_DIR?=$(git rev-parse --show-toplevel)
 
 # Add support to use Makefile on Windows

packaging/technical-addon/Makefile

@@ -1,6 +1,6 @@
 # Used for building
-SOURCE_DIR:=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
-BUILD_DIR?=$(realpath $(SOURCE_DIR)/../../)/build
+SOURCE_DIR=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+BUILD_DIR=$(realpath $(SOURCE_DIR)/../../)/build
 COMMON_MAKEFILE:=$(abspath $(SOURCE_DIR)/../../Makefile.Common)
 
 ABS_MAKEFILE_LIST := $(foreach file,$(MAKEFILE_LIST),$(abspath $(file)))
@@ -39,7 +39,7 @@ test-ta-build-tools: ta-build-tools
 	mkdir -p $(BUILD_DIR)/Sample_Addon/$(PLATFORM)_$(SPLUNK_ARCH)/bin; \
 	cd $(SOURCE_DIR) && go build $(GO_BUILD_FLAGS) -o $(BUILD_DIR)/Sample_Addon/$(PLATFORM)_$(SPLUNK_ARCH)/bin/Sample_Addon ./cmd/modinput_config_generator/internal/testdata/pkg/sample_addon/runner || exit 1; \
 	echo "built addon, testing..."
-	cd $(SOURCE_DIR) && SOURCE_DIR="$(SOURCE_DIR)/cmd/modinput_config_generator/internal/testdata" BUILD_DIR="$(BUILD_DIR)" go test -v ./...
+	cd $(SOURCE_DIR) && go test -v ./...
 
 .PHONY: generate-technical-addon
 generate-technical-addon: env-guard-all

packaging/technical-addon/cmd/modinput_config_generator/generator_test.go

@@ -29,8 +29,8 @@ import (
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/mount"
 	"github.com/google/go-cmp/cmp"
-	"github.com/splunk/splunk-technical-addon/internal/modularinput"
 	"github.com/splunk/splunk-technical-addon/internal/packaging"
+	"github.com/splunk/splunk-technical-addon/internal/testcommon"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/testcontainers/testcontainers-go"
@@ -78,7 +78,7 @@ func TestRunner(t *testing.T) {
 	ctx := context.Background()
 	addonPath := filepath.Join(t.TempDir(), "Sample_Addon.tgz")
 
-	buildDir := modularinput.GetBuildDir()
+	buildDir := testcommon.GetBuildDir()
 	require.NotEmpty(t, buildDir)
 	err := packaging.PackageAddon(filepath.Join(buildDir, "Sample_Addon"), addonPath)
 	require.NoError(t, err)
@@ -110,7 +110,9 @@ func TestRunner(t *testing.T) {
 }
 
 func TestRunnerConfigGeneration(t *testing.T) {
-
+	sourceDir, err := testcommon.GetSourceDir()
+	require.NoError(t, err)
+	sourceDir = filepath.Join(sourceDir, "cmd", "modinput_config_generator", "internal", "testdata")
 	tests := []struct {
 		testSchemaName string
 		sampleYamlPath string
@@ -120,7 +122,7 @@ func TestRunnerConfigGeneration(t *testing.T) {
 		{
 			testSchemaName: "Sample_Addon",
 			outDir:         t.TempDir(),
-			sampleYamlPath: filepath.Join(os.Getenv("SOURCE_DIR"), "pkg/sample_addon/runner/modular-inputs.yaml"),
+			sampleYamlPath: filepath.Join(sourceDir, "pkg/sample_addon/runner/modular-inputs.yaml"),
 		},
 	}
 
@@ -136,7 +138,9 @@ func TestRunnerConfigGeneration(t *testing.T) {
 }
 
 func TestInputsConfGeneration(t *testing.T) {
-
+	sourceDir, err := testcommon.GetSourceDir()
+	require.NoError(t, err)
+	sourceDir = filepath.Join(sourceDir, "cmd", "modinput_config_generator", "internal", "testdata")
 	tests := []struct {
 		testSchemaName   string
 		sampleYamlPath   string
@@ -148,8 +152,8 @@ func TestInputsConfGeneration(t *testing.T) {
 		{
 			testSchemaName: "Sample_Addon",
 			outDir:         t.TempDir(),
-			sourceDir:      filepath.Join(os.Getenv("SOURCE_DIR"), "pkg/sample_addon"),
-			sampleYamlPath: filepath.Join(os.Getenv("SOURCE_DIR"), "pkg/sample_addon/runner/modular-inputs.yaml"),
+			sourceDir:      filepath.Join(sourceDir, "pkg/sample_addon"),
+			sampleYamlPath: filepath.Join(sourceDir, "pkg/sample_addon/runner/modular-inputs.yaml"),
 		},
 	}
 

packaging/technical-addon/internal/modularinput/inputs_processor.go

@@ -143,45 +143,3 @@ func (mit *ModinputProcessor) GetMissingRequired(provided map[string]bool) []str
 	}
 	return missing
 }
-
-func GetBuildDir() string {
-	var err error
-	buildDir := os.Getenv("BUILD_DIR")
-	if buildDir == "" {
-		fmt.Println("$BUILD_DIR not set, searching for git root")
-		buildDir, err = findGitRoot(".")
-		if err != nil || buildDir == "" {
-			fmt.Println("no git dir found, defaulting to cwd")
-			buildDir, err = os.Getwd()
-			if err != nil {
-				fmt.Println("couldn't get cwd, defaulting to ./")
-				buildDir = "."
-			}
-		}
-		buildDir = filepath.Join(buildDir, "build")
-	}
-	return buildDir
-}
-
-func findGitRoot(startDir string) (string, error) {
-	dir, err := filepath.Abs(startDir)
-	if err != nil {
-		return "", fmt.Errorf("failed to get absolute path: %w", err)
-	}
-
-	for {
-		gitPath := filepath.Join(dir, ".git")
-		_, err := os.Stat(gitPath)
-		if err == nil {
-			return dir, nil
-		} else if !os.IsNotExist(err) {
-			return "", fmt.Errorf("error checking for .git: %w", err)
-		}
-
-		parentDir := filepath.Dir(dir)
-		if parentDir == dir {
-			return "", fmt.Errorf("no git repository found")
-		}
-		dir = parentDir
-	}
-}

packaging/technical-addon/internal/testcommon/paths.go

@@ -0,0 +1,85 @@
+package testcommon
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+)
+
+func GetBuildDir() string {
+	var err error
+	buildDir := os.Getenv("BUILD_DIR")
+	if buildDir == "" {
+		fmt.Println("$BUILD_DIR not set, searching for git root")
+		buildDir, err = findGitRoot(".")
+		if err != nil || buildDir == "" {
+			fmt.Println("no git dir found, defaulting to cwd")
+			buildDir, err = os.Getwd()
+			if err != nil {
+				fmt.Println("couldn't get cwd, defaulting to ./")
+				buildDir = "."
+			}
+		}
+		buildDir = filepath.Join(buildDir, "build")
+	}
+	return buildDir
+}
+
+func findGitRoot(startDir string) (string, error) {
+	dir, err := filepath.Abs(startDir)
+	if err != nil {
+		return "", fmt.Errorf("failed to get absolute path: %w", err)
+	}
+
+	for {
+		gitPath := filepath.Join(dir, ".git")
+		_, err := os.Stat(gitPath)
+		if err == nil {
+			return dir, nil
+		} else if !os.IsNotExist(err) {
+			return "", fmt.Errorf("error checking for .git: %w", err)
+		}
+
+		parentDir := filepath.Dir(dir)
+		if parentDir == dir {
+			return "", fmt.Errorf("no git repository found")
+		}
+		dir = parentDir
+	}
+}
+
+func GetSourceDir() (string, error) {
+	var err error
+	sourceDir := os.Getenv("SOURCE_DIR")
+	if sourceDir == "" {
+		fmt.Println("SOURCE_DIR not set, searching for make root")
+		sourceDir, err = findSourceRoot(".")
+		if err != nil || sourceDir == "" {
+			return "", fmt.Errorf("could not makefile to use as SOURCE_DIR and SOURCE_DIR was not specified as an env var")
+		}
+	}
+	return sourceDir, nil
+}
+
+func findSourceRoot(startDir string) (string, error) {
+	dir, err := filepath.Abs(startDir)
+	if err != nil {
+		return "", fmt.Errorf("failed to get absolute path: %w", err)
+	}
+
+	for {
+		gitPath := filepath.Join(dir, "Makefile")
+		_, err := os.Stat(gitPath)
+		if err == nil {
+			return dir, nil
+		} else if !os.IsNotExist(err) {
+			return "", fmt.Errorf("error checking for Makefile: %w", err)
+		}
+
+		parentDir := filepath.Dir(dir)
+		if parentDir == dir {
+			return "", fmt.Errorf("no Makefile found")
+		}
+		dir = parentDir
+	}
+}