main.go

package main

import (
	"errors"
	"flag"
	"fmt"
	"os"
	"path/filepath"
	"slices"
	"strings"
	"time"

	"gopkg.in/yaml.v3"
)

const (
	timeLayout = "Jan 2, 2006 at 3:04pm (UTC)"

	readmeMarkdownFilename  = "README.md"
	resultsMarkdownFilename = "RESULTS.md"
)

var (
	waitRunDur         = flag.Duration("wait-run", 3*time.Second, "wait time between tests")
	testsFile          = flag.String("i", "./tests.yml", "yaml file path contains the tests to run")
	outputDir          = flag.String("o", "./", "directory to save generaged Markdown and CSV files")
	enableREADMEOutput = flag.Bool("readme", false, "to generate a README.md file near the RESULTS.md")
	spreadsheetID      = flag.String("g-spreadsheet", "", "Google Spreadsheet ID to send results")
	// Note: we can support user credentials and token generated by user's input
	// and saved on disk at first ran (kataras/sheets already supports it)
	// but let's accept only a service account unless otherwise requested.
	googleSecretFile = flag.String("g-secret", "client_secret.json", "if g-spreadsheet is set, service account credentials file should be provided")
)

// server-benchmarks --wait-run=3s -i ./tests.dev.yml -o ./dev -g-spreadsheet $GoogleSpreadsheetID -g-secret client_secret.json
func main() {
	var specificTests stringSlice
	flag.Var(&specificTests, "t", "run only specific tests by their names") // support multiple -t flags.
	flag.Parse()

	if _, err := os.Stat("/.dockerenv"); err == nil || os.IsExist(err) {
		fmt.Fprintf(os.Stdout, "Running through docker container...")
	}

	tests, err := readTests(*testsFile)
	catch(err)

	tests = filterTests(specificTests, tests...)

	// TESTS
	for _, t := range tests {
		err = benchmark(t)
		catch(err)
	}
	cleanup()

	err = os.MkdirAll(*outputDir, 0777)
	catch(err)

	filename := filepath.Join(*outputDir, resultsMarkdownFilename)
	err = writeResults(filename, *spreadsheetID, *googleSecretFile, tests)
	catch(err)
	fmt.Fprintf(os.Stdout, "Generate: %s\n", filename)

	if *enableREADMEOutput {
		filename = filepath.Join(*outputDir, readmeMarkdownFilename)
		err = writeReadme(filename, tests)
		catch(err)
		fmt.Fprintf(os.Stdout, "Generate: %s\n", filename)
	}
}

func readTests(filename string) ([]*Test, error) {
	testsFile, err := os.OpenFile(filename, os.O_RDONLY, 0644)
	if err != nil {
		return nil, err
	}

	var tests []*Test
	if err = yaml.NewDecoder(testsFile).Decode(&tests); err != nil {
		return nil, err
	}

	if err = testsFile.Close(); err != nil {
		return nil, err
	}

	if len(tests) == 0 {
		return nil, fmt.Errorf("no tests to run")
	}

	return tests, nil
}

func filterTests(specificTests stringSlice, tests ...*Test) []*Test {
	if len(specificTests) == 0 {
		return tests
	}

	testsAndEnvsToKeep := make(map[string][]string, len(specificTests))
	for _, specificTest := range specificTests {
		if specificTestName := strings.ToLower(specificTest); specificTestName != "" {
			specificTestEnvName := ""
			if dotParts := strings.Split(specificTestName, "."); len(dotParts) > 1 {
				specificTestName = strings.Join(dotParts[0:len(dotParts)-1], ".") // name all except last dot.
				specificTestEnvName = dotParts[len(dotParts)-1]
			}
			testsAndEnvsToKeep[specificTestName] = append(testsAndEnvsToKeep[specificTestName], specificTestEnvName)
		}
	}

	// Delete all tests and envs that are not in the specificTests list.
	return slices.DeleteFunc(tests, func(t *Test) bool {
		// keep only the specific test.
		testName := strings.ToLower(t.Name)
		if specificTestEnvNames, ok := testsAndEnvsToKeep[testName]; ok {
			// keep only the specific test's environment.
			// E.g. -t rest.iris -t rest.iris-private
			if len(specificTestEnvNames) > 0 {
				t.Envs = slices.DeleteFunc(t.Envs, func(e *TestEnv) bool {
					return !slices.Contains(specificTestEnvNames, strings.ToLower(e.GetName()))
				})
			}

			return false
		}

		return true
	})
}

func cleanup() {
	for i, f := range downloadedFiles {
		if err := os.Remove(f); err != nil && !errors.Is(err, os.ErrNotExist) {
			fmt.Fprintf(os.Stdout, "remove: %v\n", err)
		}

		// delete slice element.
		downloadedFiles = append(downloadedFiles[:i], downloadedFiles[i+1:]...)
	}
}

func catch(err error) {
	if err != nil {
		cleanup()
		panic(err)
	}
}