Try adding a file at the top-level that uses the package name

cmd/cryptarch/main.go

@@ -4,22 +4,18 @@
 package main
 
 import (
-	"context"
 	"flag"
-	"fmt"
 	"io"
 	"log"
 	"os"
 	"strings"
 
 	"golang.org/x/exp/slog"
 
+	"github.com/spacez320/cryptarch"
 	"github.com/spacez320/cryptarch/internal/lib"
 )
 
-// Represents the mode value.
-type queryMode int
-
 // Queries provided as flags.
 type queriesArg []string
 
@@ -41,17 +37,10 @@ func (q *queriesArg) ToStrings() (q_strings []string) {
 	return
 }
 
-// Mode constants.
-const (
-	MODE_QUERY   queryMode = iota + 1 // For running in 'query' mode.
-	MODE_PROFILE                      // For running in 'profile' mode.
-	MODE_READ                         // For running in 'read' mode.
-)
-
 // Misc. constants.
 const (
-	CONFIG_FILE_DIR  = "cryptarch"
-	CONFIG_FILE_NAME = "cryptarch.yaml"
+	CONFIG_FILE_DIR  = "cryptarch"      // Directory for Cryptarch configuration.
+	CONFIG_FILE_NAME = "cryptarch.yaml" // Cryptarch configuration file.
 )
 
 var (
@@ -76,8 +65,7 @@ var (
 	showStatus          bool       // Whether or not to show statuses.
 	silent              bool       // Whether or not to be quiet.
 
-	ctx                    = context.Background() // Initialize context.
-	logger                 = log.Default()        // Logging system.
+	logger                 = log.Default() // Logging system.
 	logLevelStrToSlogLevel = map[string]slog.Level{
 		"debug": slog.LevelDebug,
 		"error": slog.LevelError,
@@ -86,25 +74,17 @@ var (
 	} // Log levels acceptable as a flag.
 )
 
-// Parses a comma delimited argument string, returning a slice of strings if any are found, or an
-// empty slice if not.
-func parseCommaDelimitedArg(arg string) []string {
-	if parsed := strings.Split(arg, ","); parsed[0] == "" {
+// Parses a comma delimited  string, returning a slice of strings if any are found, or an empty
+// slice if not.
+func parseCommaDelimitedStrOrEmpty(s string) []string {
+	if parsed := strings.Split(s, ","); parsed[0] == "" {
 		return []string{}
 	} else {
 		return parsed
 	}
 }
 
 func main() {
-	var (
-		doneQueriesChan chan bool            // Channel for tracking query completion.
-		pauseQueryChans map[string]chan bool // Channels for pausing queries.
-
-		displayConfig    = lib.NewDisplayConfig() // Configuration for display modes.
-		resultsReadyChan = make(chan bool)        // Channel for signaling results readiness.
-	)
-
 	// Define arguments.
 	flag.BoolVar(&history, "history", true, "Whether or not to use or preserve history.")
 	flag.BoolVar(&showHelp, "show-help", true, "Whether or not to show help displays.")
@@ -114,7 +94,7 @@ func main() {
 	flag.IntVar(&count, "count", 1, "Number of query executions. -1 for continuous.")
 	flag.IntVar(&delay, "delay", 3, "Delay between queries (seconds).")
 	flag.IntVar(&displayMode, "display", int(lib.DISPLAY_MODE_RAW), "Result mode to display.")
-	flag.IntVar(&mode, "mode", int(MODE_QUERY), "Mode to execute in.")
+	flag.IntVar(&mode, "mode", int(cryptarch.MODE_QUERY), "Mode to execute in.")
 	flag.IntVar(&outerPaddingBottom, "outer-padding-bottom", -1, "Bottom display padding.")
 	flag.IntVar(&outerPaddingLeft, "outer-padding-left", -1, "Left display padding.")
 	flag.IntVar(&outerPaddingRight, "outer-padding-right", -1, "Right display padding.")
@@ -143,53 +123,23 @@ func main() {
 		)))
 	}
 
-	// Execute the specified mode.
-	switch {
-	case mode == int(MODE_PROFILE):
-		slog.Debug("Executing in profile mode.")
-
-		doneQueriesChan, pauseQueryChans = lib.Query(
-			lib.QUERY_MODE_PROFILE,
-			count,
-			delay,
-			queries,
-			port,
-			history,
-			resultsReadyChan,
-		)
-
-		// Process mode has specific labels--ignore user provided ones.
-		ctx = context.WithValue(ctx, "labels", lib.ProfileLabels)
-	case mode == int(MODE_QUERY):
-		slog.Debug("Executing in query mode.")
-
-		doneQueriesChan, pauseQueryChans = lib.Query(
-			lib.QUERY_MODE_COMMAND,
-			count,
-			delay,
-			queries,
-			port,
-			history,
-			resultsReadyChan,
-		)
-
-		// Rely on user-defined labels.
-		ctx = context.WithValue(ctx, "labels", parseCommaDelimitedArg(labels))
-	case mode == int(MODE_READ):
-		slog.Debug("Executing in read mode.")
-
-	// FIXME Temporarily disabling read mode.
-	// 	done = lib.Read(port)
-	default:
-		slog.Error(fmt.Sprintf("Invalid mode: %d\n", mode))
-		os.Exit(1)
+	// Build general configuration.
+	config := lib.Config{
+		Count:                  count,
+		Delay:                  delay,
+		DisplayMode:            displayMode,
+		Filters:                parseCommaDelimitedStrOrEmpty(filters),
+		History:                history,
+		Labels:                 parseCommaDelimitedStrOrEmpty(labels),
+		Mode:                   mode,
+		Port:                   port,
+		PrometheusExporterAddr: promExporterAddr,
+		PushgatewayAddr:        promPushgatewayAddr,
+		Queries:                queries,
 	}
 
-	// Initialize remaining context.
-	ctx = context.WithValue(ctx, "filters", parseCommaDelimitedArg(filters))
-	ctx = context.WithValue(ctx, "queries", queries.ToStrings())
-
-	// Set-up display configuration.
+	// Build display configuration.
+	displayConfig := lib.NewDisplayConfig()
 	displayConfig.ShowHelp = showHelp
 	displayConfig.ShowLogs = showLogs
 	displayConfig.ShowStatus = showStatus
@@ -206,27 +156,5 @@ func main() {
 		displayConfig.OuterPaddingTop = outerPaddingTop
 	}
 
-	// Execute result viewing.
-	if !silent {
-		lib.Results(
-			ctx,
-			lib.DisplayMode(displayMode),
-			ctx.Value("queries").([]string)[0], // Always start with the first query.
-			history,
-			displayConfig,
-			&lib.Config{
-				LogLevel:               logLevel,
-				PrometheusExporterAddr: promExporterAddr,
-				PushgatewayAddr:        promPushgatewayAddr,
-			},
-			pauseQueryChans,
-			resultsReadyChan,
-		)
-	}
-
-	// XXX This isn't strictly necessary, mainly because getting here shouldn't be possible
-	// (`lib.Results` does not have any intentional return condition), but it's being left here in
-	// case in the future we do want to control for query completion.
-	<-doneQueriesChan
-	close(doneQueriesChan)
+	cryptarch.Run(config, *displayConfig)
 }

cmd/cryptarch/main_test.go

@@ -16,7 +16,7 @@ const (
 
 var (
 	// Filepath for the Cryptarch executable.
-	cryptarch = filepath.Join(CRYPTARCH_BINARY_DIR, CRYPTARCH_BINARY_NAME)
+	cryptarchExec = filepath.Join(CRYPTARCH_BINARY_DIR, CRYPTARCH_BINARY_NAME)
 	// Environment to execute Cryptarch with, appended to `os.Environ()`.
 	testEnviron = map[string]string{
 		"GOCOVERDIR": ".coverdata",
@@ -35,7 +35,7 @@ func environToA(environ map[string]string) (a string) {
 
 // Builds the Cryptarch binary.
 func buildCryptarch() ([]byte, error) {
-	cmd := exec.Command("go", "build", "-o", cryptarch)
+	cmd := exec.Command("go", "build", "-o", cryptarchExec)
 	return cmd.CombinedOutput()
 }
 
@@ -45,7 +45,7 @@ func runCryptarch(args []string) ([]byte, error) {
 		environ = append(os.Environ(), environToA(testEnviron))
 	)
 
-	cmd := exec.Command(cryptarch, args...)
+	cmd := exec.Command(cryptarchExec, args...)
 	cmd.Env = environ
 	return cmd.CombinedOutput()
 }

cryptarch.go

@@ -0,0 +1,108 @@
+//
+// Laucnher for Cryptarch.
+
+package cryptarch
+
+import (
+	"context"
+	"fmt"
+	"os"
+
+	"golang.org/x/exp/slog"
+
+	"github.com/spacez320/cryptarch/internal/lib"
+)
+
+// Represents the mode value.
+type queryMode int
+
+// Mode constants.
+const (
+	MODE_QUERY   queryMode = iota + 1 // For running in 'query' mode.
+	MODE_PROFILE                      // For running in 'profile' mode.
+	MODE_READ                         // For running in 'read' mode.
+)
+
+var (
+	ctx = context.Background() // Initialize context.
+)
+
+// Executes a Cryptarch.
+func Run(config lib.Config, displayConfig lib.DisplayConfig) {
+	var (
+		doneQueriesChan chan bool            // Channel for tracking query completion.
+		pauseQueryChans map[string]chan bool // Channels for pausing queries.
+
+		resultsReadyChan = make(chan bool) // Channel for signaling results readiness.
+	)
+
+	// Execute the specified mode.
+	switch {
+	case config.Mode == int(MODE_PROFILE):
+		slog.Debug("Executing in profile mode.")
+
+		doneQueriesChan, pauseQueryChans = lib.Query(
+			lib.QUERY_MODE_PROFILE,
+			config.Count,
+			config.Delay,
+			config.Queries,
+			config.Port,
+			config.History,
+			resultsReadyChan,
+		)
+
+		// Process mode has specific labels--ignore user provided ones.
+		ctx = context.WithValue(ctx, "labels", lib.ProfileLabels)
+	case config.Mode == int(MODE_QUERY):
+		slog.Debug("Executing in query mode.")
+
+		doneQueriesChan, pauseQueryChans = lib.Query(
+			lib.QUERY_MODE_COMMAND,
+			config.Count,
+			config.Delay,
+			config.Queries,
+			config.Port,
+			config.History,
+			resultsReadyChan,
+		)
+
+		// Rely on user-defined labels.
+		ctx = context.WithValue(ctx, "labels", config.Labels)
+	case config.Mode == int(MODE_READ):
+		slog.Debug("Executing in read mode.")
+
+	// FIXME Temporarily disabling read mode.
+	// 	done = lib.Read(port)
+	default:
+		slog.Error(fmt.Sprintf("Invalid mode: %d\n", config.Mode))
+		os.Exit(1)
+	}
+
+	// Initialize remaining context.
+	ctx = context.WithValue(ctx, "filters", config.Filters)
+	ctx = context.WithValue(ctx, "queries", config.Queries)
+
+	// Execute result viewing.
+	if !config.Silent {
+		lib.Results(
+			ctx,
+			lib.DisplayMode(config.DisplayMode),
+			ctx.Value("queries").([]string)[0], // Always start with the first query.
+			config.History,
+			&displayConfig,
+			&lib.Config{
+				LogLevel:               config.LogLevel,
+				PrometheusExporterAddr: config.PrometheusExporterAddr,
+				PushgatewayAddr:        config.PushgatewayAddr,
+			},
+			pauseQueryChans,
+			resultsReadyChan,
+		)
+	}
+
+	// XXX This isn't strictly necessary, mainly because getting here shouldn't be possible
+	// (`lib.Results` does not have any intentional return condition), but it's being left here in
+	// case in the future we do want to control for query completion.
+	<-doneQueriesChan
+	close(doneQueriesChan)
+}

internal/lib/config.go

@@ -1,9 +1,11 @@
 //
-// Controls shared configuration settings.
+// Shared configuration settings.
 
 package lib
 
-import "golang.org/x/exp/slog"
+import (
+	"golang.org/x/exp/slog"
+)
 
 var (
 	logLevelStrtoSlogLevel = map[string]slog.Level{
@@ -14,11 +16,15 @@ var (
 	} // Mapping of human-readable log levels to Slog levels.
 )
 
-// Shareable configuration.
+// Shareable configuration. See CLI flags for further details.
 type Config struct {
-	LogLevel               string // Log level.
-	PrometheusExporterAddr string // Prometheus exporter address.
-	PushgatewayAddr        string // Pushgateway address.
+	Count, Delay, DisplayMode, Mode int
+	Filters, Labels, Queries        []string
+	History, Silent                 bool
+	LogLevel                        string
+	Port                            string
+	PrometheusExporterAddr          string
+	PushgatewayAddr                 string
 }
 
 // Retrieves an Slog level from a human-readable level string.