Skip to content

Commit

Permalink
Rudimentary and hacky implementation of test suites
Browse files Browse the repository at this point in the history
  • Loading branch information
na-- committed Dec 9, 2022
1 parent df96e04 commit e8d93ec
Show file tree
Hide file tree
Showing 21 changed files with 558 additions and 354 deletions.
2 changes: 1 addition & 1 deletion api/v1/group_routes_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func getControlSurface(tb testing.TB, testState *lib.TestRunState) *ControlSurfa
execScheduler, err := execution.NewScheduler(testState, local.NewController())
require.NoError(tb, err)

me, err := engine.NewMetricsEngine(testState, true)
me, err := engine.NewMetricsEngine(testState.Registry, testState.Logger)
require.NoError(tb, err)

ctx, cancel := context.WithCancel(context.Background())
Expand Down
2 changes: 1 addition & 1 deletion api/v1/setup_teardown_routes_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ func TestSetupData(t *testing.T) {

execScheduler, err := execution.NewScheduler(testState, local.NewController())
require.NoError(t, err)
metricsEngine, err := engine.NewMetricsEngine(testState, true)
metricsEngine, err := engine.NewMetricsEngine(testState.Registry, testState.Logger)
require.NoError(t, err)

globalCtx, globalCancel := context.WithCancel(context.Background())
Expand Down
2 changes: 1 addition & 1 deletion api/v1/status_routes_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func TestPatchStatus(t *testing.T) {
execScheduler, err := execution.NewScheduler(testState, local.NewController())
require.NoError(t, err)

metricsEngine, err := engine.NewMetricsEngine(testState, true)
metricsEngine, err := engine.NewMetricsEngine(testState.Registry, testState.Logger)
require.NoError(t, err)

globalCtx, globalCancel := context.WithCancel(context.Background())
Expand Down
135 changes: 73 additions & 62 deletions cmd/agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,72 @@ func getMetricsHook(
}
}

func loadAndConfigureDistTest(gs *globalState, distTest *distributed.Test) (*loadedAndConfiguredTest, error) {
var options lib.Options
if err := json.Unmarshal(distTest.Options, &options); err != nil {
return nil, err
}

arc, err := lib.ReadArchive(bytes.NewReader(distTest.Archive))
if err != nil {
return nil, err
}

registry := metrics.NewRegistry()
piState := &lib.TestPreInitState{
Logger: gs.logger,
RuntimeOptions: lib.RuntimeOptions{
NoThresholds: null.BoolFrom(true),
NoSummary: null.BoolFrom(true),
Env: arc.Env,
CompatibilityMode: null.StringFrom(arc.CompatibilityMode),
},
Registry: registry,
BuiltinMetrics: metrics.RegisterBuiltinMetrics(registry),
}

initRunner, err := js.NewFromArchive(piState, arc)
if err != nil {
return nil, err
}

test := &loadedTest{
pwd: arc.Pwd,
sourceRootPath: arc.Filename,
source: &loader.SourceData{
Data: distTest.Archive,
URL: arc.FilenameURL,
},
fs: afero.NewMemMapFs(), // TODO: figure out what should be here
fileSystems: arc.Filesystems,
preInitState: piState,
initRunner: initRunner,
}

pseudoConsoldatedConfig := applyDefault(Config{Options: options})
for _, thresholds := range pseudoConsoldatedConfig.Thresholds {
if err = thresholds.Parse(); err != nil {
return nil, err
}
}
derivedConfig, err := deriveAndValidateConfig(pseudoConsoldatedConfig, initRunner.IsExecutable, gs.logger)
if err != nil {
return nil, err
}

return &loadedAndConfiguredTest{
loadedTest: test,
consolidatedConfig: pseudoConsoldatedConfig,
derivedConfig: derivedConfig,
}, nil
}

// TODO: a whole lot of cleanup, refactoring, error handling and hardening
func getCmdAgent(gs *globalState) *cobra.Command { //nolint: funlen
func getCmdAgent(gs *globalState) *cobra.Command {
c := &cmdsRunAndAgent{gs: gs}

c.loadConfiguredTest = func(cmd *cobra.Command, args []string) (
*loadedAndConfiguredTest, execution.Controller, error,
c.loadConfiguredTests = func(cmd *cobra.Command, args []string) (
[]*loadedAndConfiguredTest, execution.Controller, error,
) {
conn, err := grpc.Dial(args[0], grpc.WithInsecure())
if err != nil {
Expand All @@ -107,74 +167,25 @@ func getCmdAgent(gs *globalState) *cobra.Command { //nolint: funlen
return nil, nil, err
}

c.metricsEngineHook = getMetricsHook(gs.ctx, resp.InstanceID, client, gs.logger)

controller, err := distributed.NewAgentController(gs.ctx, resp.InstanceID, client, gs.logger)
if err != nil {
return nil, nil, err
}

var options lib.Options
if err := json.Unmarshal(resp.Options, &options); err != nil {
return nil, nil, err
}

arc, err := lib.ReadArchive(bytes.NewReader(resp.Archive))
if err != nil {
return nil, nil, err
}

registry := metrics.NewRegistry()
piState := &lib.TestPreInitState{
Logger: gs.logger,
RuntimeOptions: lib.RuntimeOptions{
NoThresholds: null.BoolFrom(true),
NoSummary: null.BoolFrom(true),
Env: arc.Env,
CompatibilityMode: null.StringFrom(arc.CompatibilityMode),
},
Registry: registry,
BuiltinMetrics: metrics.RegisterBuiltinMetrics(registry),
}

initRunner, err := js.NewFromArchive(piState, arc)
if err != nil {
return nil, nil, err
}

test := &loadedTest{
pwd: arc.Pwd,
sourceRootPath: arc.Filename,
source: &loader.SourceData{
Data: resp.Archive,
URL: arc.FilenameURL,
},
fs: afero.NewMemMapFs(), // TODO: figure out what should be here
fileSystems: arc.Filesystems,
preInitState: piState,
initRunner: initRunner,
}

pseudoConsoldatedConfig := applyDefault(Config{Options: options})
for _, thresholds := range pseudoConsoldatedConfig.Thresholds {
if err = thresholds.Parse(); err != nil {
var configuredTests []*loadedAndConfiguredTest
for _, test := range resp.Tests {
cTest, err := loadAndConfigureDistTest(gs, test)
if err != nil {
return nil, nil, err
}
configuredTests = append(configuredTests, cTest)
}
derivedConfig, err := deriveAndValidateConfig(pseudoConsoldatedConfig, initRunner.IsExecutable, gs.logger)

c.metricsEngineHook = getMetricsHook(gs.ctx, resp.InstanceID, client, gs.logger)

controller, err := distributed.NewAgentController(gs.ctx, resp.InstanceID, client, gs.logger)
if err != nil {
return nil, nil, err
}

configuredTest := &loadedAndConfiguredTest{
loadedTest: test,
consolidatedConfig: pseudoConsoldatedConfig,
derivedConfig: derivedConfig,
}

gs.flags.address = "" // TODO: fix, this is a hack so agents don't start an API server

return configuredTest, controller, nil // TODO
return configuredTests, controller, nil // TODO
}

agentCmd := &cobra.Command{
Expand Down
8 changes: 6 additions & 2 deletions cmd/archive.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ type cmdArchive struct {
}

func (c *cmdArchive) run(cmd *cobra.Command, args []string) error {
test, err := loadAndConfigureLocalTest(c.gs, cmd, args, getPartialConfig)
preInitState, err := getPreInitState(c.gs, cmd)
if err != nil {
return err
}
test, err := loadAndConfigureLocalTest(c.gs, preInitState, cmd, args[0], getPartialConfig)
if err != nil {
return err
}
Expand Down Expand Up @@ -84,7 +88,7 @@ An archive is a fully self-contained test run, and can be executed identically e
# Run the resulting archive.
k6 run myarchive.tar`[1:],
Args: cobra.ExactArgs(1),
Args: cobra.ExactArgs(1), // TODO: remove and support test suites?
RunE: c.run,
}

Expand Down
6 changes: 5 additions & 1 deletion cmd/cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,11 @@ func (c *cmdCloud) run(cmd *cobra.Command, args []string) error {
)
printBar(c.gs, progressBar)

test, err := loadAndConfigureLocalTest(c.gs, cmd, args, getPartialConfig)
preInitState, err := getPreInitState(c.gs, cmd)
if err != nil {
return err
}
test, err := loadAndConfigureLocalTest(c.gs, preInitState, cmd, args[0], getPartialConfig)
if err != nil {
return err
}
Expand Down
1 change: 1 addition & 0 deletions cmd/convert.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
)

// TODO: split apart like `k6 run` and `k6 archive`?
//
//nolint:funlen,gocognit
func getCmdConvert(globalState *globalState) *cobra.Command {
var (
Expand Down
42 changes: 29 additions & 13 deletions cmd/coordinator.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,36 +27,52 @@ type cmdCoordinator struct {
func (c *cmdCoordinator) run(cmd *cobra.Command, args []string) (err error) {
ctx, runAbort := execution.NewTestRunContext(c.gs.ctx, c.gs.logger)

test, err := loadAndConfigureLocalTest(c.gs, cmd, args, getPartialConfig)
tests, err := loadAndConfigureLocalTests(c.gs, cmd, args, getPartialConfig)
if err != nil {
return err
}

// Only consolidated options, not derived
testRunState, err := test.buildTestRunState(test.consolidatedConfig.Options)
// TODO: refactor at some point, this limits us to handleSummary() from the first test
firstTest := tests[0]
// TODO: refactor - this is safe, preInitState is the same for all tests,
// but it's still icky to get it that way
preInitState := firstTest.preInitState
metricsEngine, err := engine.NewMetricsEngine(preInitState.Registry, c.gs.logger)
if err != nil {
return err
}

shouldProcessMetrics := !testRunState.RuntimeOptions.NoSummary.Bool || !testRunState.RuntimeOptions.NoThresholds.Bool
metricsEngine, err := engine.NewMetricsEngine(testRunState, shouldProcessMetrics)
if err != nil {
return err
testArchives := make([]*lib.Archive, len(tests))
for i, test := range tests {
runState, err := test.buildTestRunState(test.consolidatedConfig.Options)
if err != nil {
return err
}

// We get the thresholds from all tests
testArchives[i] = runState.Runner.MakeArchive()
err = metricsEngine.InitSubMetricsAndThresholds(
test.derivedConfig.Options,
preInitState.RuntimeOptions.NoThresholds.Bool,
)
if err != nil {
return err
}
}

coordinator, err := distributed.NewCoordinatorServer(
c.instanceCount, test.initRunner.MakeArchive(), metricsEngine, c.gs.logger,
c.instanceCount, testArchives, metricsEngine, c.gs.logger,
)
if err != nil {
return err
}

if !testRunState.RuntimeOptions.NoSummary.Bool {
if !preInitState.RuntimeOptions.NoSummary.Bool {
defer func() {
c.gs.logger.Debug("Generating the end-of-test summary...")
summaryResult, serr := test.initRunner.HandleSummary(ctx, &lib.Summary{
summaryResult, serr := firstTest.initRunner.HandleSummary(ctx, &lib.Summary{
Metrics: metricsEngine.ObservedMetrics,
RootGroup: test.initRunner.GetDefaultGroup(),
RootGroup: firstTest.initRunner.GetDefaultGroup(),
TestRunDuration: coordinator.GetCurrentTestRunDuration(),
NoColor: c.gs.flags.noColor,
UIState: lib.UIState{
Expand All @@ -73,9 +89,9 @@ func (c *cmdCoordinator) run(cmd *cobra.Command, args []string) (err error) {
}()
}

if !testRunState.RuntimeOptions.NoThresholds.Bool {
if !preInitState.RuntimeOptions.NoThresholds.Bool {
getCurrentTestDuration := coordinator.GetCurrentTestRunDuration
finalizeThresholds := metricsEngine.StartThresholdCalculations(getCurrentTestDuration, runAbort)
finalizeThresholds := metricsEngine.StartThresholdCalculations(nil, getCurrentTestDuration, runAbort)

defer func() {
// This gets called after all of the outputs have stopped, so we are
Expand Down
9 changes: 7 additions & 2 deletions cmd/inspect.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,14 @@ func getCmdInspect(gs *globalState) *cobra.Command {
Use: "inspect [file]",
Short: "Inspect a script or archive",
Long: `Inspect a script or archive.`,
Args: cobra.ExactArgs(1),
Args: cobra.ExactArgs(1), // TODO: remove and support test suites?
RunE: func(cmd *cobra.Command, args []string) error {
test, err := loadLocalTest(gs, cmd, args)
preInitState, err := getPreInitState(gs, cmd)
if err != nil {
return err
}

test, err := loadLocalTest(gs, preInitState, cmd, args[0])
if err != nil {
return err
}
Expand Down
Loading

0 comments on commit e8d93ec

Please sign in to comment.