From 6a5df5c440bc00f8fecb3f1da18844e6602a218b Mon Sep 17 00:00:00 2001 From: Albert Manya Date: Thu, 13 Jul 2017 16:46:34 +0200 Subject: [PATCH] Improve naming and consistence --- cli.go | 14 +++++----- config/config.go | 6 ++--- processor.go | 44 +++++++++++++++---------------- processor_pool.go | 20 +++++++------- processor_test.go | 12 ++++----- step_transform_build_json.go | 12 ++++----- step_transform_build_json_test.go | 6 ++--- 7 files changed, 57 insertions(+), 57 deletions(-) diff --git a/cli.go b/cli.go index 21d512127..677fe7d65 100644 --- a/cli.go +++ b/cli.go @@ -165,13 +165,13 @@ func (i *CLI) Setup() (bool, error) { Hostname: i.Config.Hostname, Context: ctx, - HardTimeout: i.Config.HardTimeout, - InitialSleep: i.Config.InitialSleep, - LogTimeout: i.Config.LogTimeout, - MaxLogLength: i.Config.MaxLogLength, - ScriptUploadTimeout: i.Config.ScriptUploadTimeout, - StartupTimeout: i.Config.StartupTimeout, - PayloadFilterScript: i.Config.FilterJobJsonScript, + HardTimeout: i.Config.HardTimeout, + InitialSleep: i.Config.InitialSleep, + LogTimeout: i.Config.LogTimeout, + MaxLogLength: i.Config.MaxLogLength, + ScriptUploadTimeout: i.Config.ScriptUploadTimeout, + StartupTimeout: i.Config.StartupTimeout, + PayloadFilterExecutable: i.Config.PayloadFilterExecutable, } pool := NewProcessorPool(ppc, i.BackendProvider, i.BuildScriptGenerator, i.CancellationBroadcaster) diff --git a/config/config.go b/config/config.go index d6b266747..6aba53c8a 100644 --- a/config/config.go +++ b/config/config.go @@ -166,8 +166,8 @@ var ( NewConfigDef("BuildCacheS3SecretAccessKey", &cli.StringFlag{}), // non-config and special case flags - NewConfigDef("FilterJobJsonScript", &cli.StringFlag{ - Usage: "External script which will be called to filter the json to be sent to the build script generator", + NewConfigDef("PayloadFilterExecutable", &cli.StringFlag{ + Usage: "External executable which will be called to filter the json to be sent to the build script generator", }), NewConfigDef("SkipShutdownOnLogTimeout", &cli.BoolFlag{ Usage: "Special-case mode to aid with debugging timed out jobs", @@ -347,7 +347,7 @@ type Config struct { BuildCacheS3AccessKeyID string `config:"build-cache-s3-access-key-id"` BuildCacheS3SecretAccessKey string `config:"build-cache-s3-secret-access-key"` - FilterJobJsonScript string `config:"filter-job-json-script"` + PayloadFilterExecutable string `config:"payload-filter-executable"` ProviderConfig *ProviderConfig } diff --git a/processor.go b/processor.go index 9d9b4e85c..c8ca6ee85 100644 --- a/processor.go +++ b/processor.go @@ -18,13 +18,13 @@ type Processor struct { ID uuid.UUID hostname string - hardTimeout time.Duration - initialSleep time.Duration - logTimeout time.Duration - maxLogLength int - scriptUploadTimeout time.Duration - startupTimeout time.Duration - payloadFilterScript string + hardTimeout time.Duration + initialSleep time.Duration + logTimeout time.Duration + maxLogLength int + scriptUploadTimeout time.Duration + startupTimeout time.Duration + payloadFilterExecutable string ctx gocontext.Context buildJobsChan <-chan Job @@ -51,13 +51,13 @@ type Processor struct { } type ProcessorConfig struct { - HardTimeout time.Duration - InitialSleep time.Duration - LogTimeout time.Duration - MaxLogLength int - ScriptUploadTimeout time.Duration - StartupTimeout time.Duration - PayloadFilterScript string + HardTimeout time.Duration + InitialSleep time.Duration + LogTimeout time.Duration + MaxLogLength int + ScriptUploadTimeout time.Duration + StartupTimeout time.Duration + PayloadFilterExecutable string } // NewProcessor creates a new processor that will run the build jobs on the @@ -83,13 +83,13 @@ func NewProcessor(ctx gocontext.Context, hostname string, queue JobQueue, ID: processorUUID, hostname: hostname, - initialSleep: config.InitialSleep, - hardTimeout: config.HardTimeout, - logTimeout: config.LogTimeout, - scriptUploadTimeout: config.ScriptUploadTimeout, - startupTimeout: config.StartupTimeout, - maxLogLength: config.MaxLogLength, - payloadFilterScript: config.PayloadFilterScript, + initialSleep: config.InitialSleep, + hardTimeout: config.HardTimeout, + logTimeout: config.LogTimeout, + scriptUploadTimeout: config.ScriptUploadTimeout, + startupTimeout: config.StartupTimeout, + maxLogLength: config.MaxLogLength, + payloadFilterExecutable: config.PayloadFilterExecutable, ctx: ctx, buildJobsChan: buildJobsChan, @@ -198,7 +198,7 @@ func (p *Processor) process(ctx gocontext.Context, buildJob Job) { cancellationBroadcaster: p.cancellationBroadcaster, }, &stepTransformBuildJSON{ - payloadFilterScript: p.payloadFilterScript, + payloadFilterExecutable: p.payloadFilterExecutable, }, &stepGenerateScript{ generator: p.generator, diff --git a/processor_pool.go b/processor_pool.go index c86f96b5f..896b0be8f 100644 --- a/processor_pool.go +++ b/processor_pool.go @@ -25,7 +25,7 @@ type ProcessorPool struct { HardTimeout, InitialSleep, LogTimeout, ScriptUploadTimeout, StartupTimeout time.Duration MaxLogLength int - PayloadFilterScript string + PayloadFilterExecutable string SkipShutdownOnLogTimeout bool @@ -44,7 +44,7 @@ type ProcessorPoolConfig struct { HardTimeout, InitialSleep, LogTimeout, ScriptUploadTimeout, StartupTimeout time.Duration MaxLogLength int - PayloadFilterScript string + PayloadFilterExecutable string } // NewProcessorPool creates a new processor pool using the given arguments. @@ -66,7 +66,7 @@ func NewProcessorPool(ppc *ProcessorPoolConfig, Provider: provider, Generator: generator, CancellationBroadcaster: cancellationBroadcaster, - PayloadFilterScript: ppc.PayloadFilterScript, + PayloadFilterExecutable: ppc.PayloadFilterExecutable, } } @@ -184,13 +184,13 @@ func (p *ProcessorPool) runProcessor(queue JobQueue) error { proc, err := NewProcessor(ctx, p.Hostname, queue, p.Provider, p.Generator, p.CancellationBroadcaster, ProcessorConfig{ - HardTimeout: p.HardTimeout, - InitialSleep: p.InitialSleep, - LogTimeout: p.LogTimeout, - MaxLogLength: p.MaxLogLength, - ScriptUploadTimeout: p.ScriptUploadTimeout, - StartupTimeout: p.StartupTimeout, - PayloadFilterScript: p.PayloadFilterScript, + HardTimeout: p.HardTimeout, + InitialSleep: p.InitialSleep, + LogTimeout: p.LogTimeout, + MaxLogLength: p.MaxLogLength, + ScriptUploadTimeout: p.ScriptUploadTimeout, + StartupTimeout: p.StartupTimeout, + PayloadFilterExecutable: p.PayloadFilterExecutable, }) if err != nil { diff --git a/processor_test.go b/processor_test.go index 3706940d3..0cee1b71c 100644 --- a/processor_test.go +++ b/processor_test.go @@ -39,12 +39,12 @@ func TestProcessor(t *testing.T) { cancellationBroadcaster := NewCancellationBroadcaster() processor, err := NewProcessor(ctx, "test-hostname", jobQueue, provider, generator, cancellationBroadcaster, ProcessorConfig{ - HardTimeout: 2 * time.Second, - LogTimeout: time.Second, - ScriptUploadTimeout: 3 * time.Second, - StartupTimeout: 4 * time.Second, - MaxLogLength: 4500000, - PayloadFilterScript: "filter.py", + HardTimeout: 2 * time.Second, + LogTimeout: time.Second, + ScriptUploadTimeout: 3 * time.Second, + StartupTimeout: 4 * time.Second, + MaxLogLength: 4500000, + PayloadFilterExecutable: "filter.py", }) if err != nil { t.Error(err) diff --git a/step_transform_build_json.go b/step_transform_build_json.go index 57bacb2fb..0ab3ef8ea 100644 --- a/step_transform_build_json.go +++ b/step_transform_build_json.go @@ -12,7 +12,7 @@ import ( ) type stepTransformBuildJSON struct { - payloadFilterScript string + payloadFilterExecutable string } type EnvVar struct { @@ -25,16 +25,16 @@ func (s *stepTransformBuildJSON) Run(state multistep.StateBag) multistep.StepAct buildJob := state.Get("buildJob").(Job) ctx := state.Get("ctx").(gocontext.Context) - if s.payloadFilterScript == "" { - context.LoggerFromContext(ctx).Info("skipping json transformation, no filter script defined") + if s.payloadFilterExecutable == "" { + context.LoggerFromContext(ctx).Info("skipping json transformation, no filter executable defined") return multistep.ActionContinue } - context.LoggerFromContext(ctx).Info(fmt.Sprintf("calling filter script: %s", s.payloadFilterScript)) + context.LoggerFromContext(ctx).Info(fmt.Sprintf("calling filter executable: %s", s.payloadFilterExecutable)) payload := buildJob.RawPayload() - cmd := exec.Command(s.payloadFilterScript) + cmd := exec.Command(s.payloadFilterExecutable) rawJson, err := payload.MarshalJSON() if err != nil { context.LoggerFromContext(ctx).Info(fmt.Sprintf("failed to marshal json: %v", err)) @@ -48,7 +48,7 @@ func (s *stepTransformBuildJSON) Run(state multistep.StateBag) multistep.StepAct err = cmd.Run() if err != nil { - context.LoggerFromContext(ctx).Info(fmt.Sprintf("failed to execute filter script: %v", err)) + context.LoggerFromContext(ctx).Info(fmt.Sprintf("failed to run filter executable: %v", err)) return multistep.ActionContinue } diff --git a/step_transform_build_json_test.go b/step_transform_build_json_test.go index 952d14412..d41841d16 100644 --- a/step_transform_build_json_test.go +++ b/step_transform_build_json_test.go @@ -37,7 +37,7 @@ func setupStepTransformBuildJSON(cfg *config.ProviderConfig) (*stepTransformBuil func TestStepTransformBuildJSON_Run(t *testing.T) { cfg := config.ProviderConfigFromMap(map[string]string{ - "FILTER_JOB_JSON_SCRIPT": "", + "PAYLOAD_FILTER_EXECUTABLE": "", }) s, state := setupStepTransformBuildJSON(cfg) @@ -45,10 +45,10 @@ func TestStepTransformBuildJSON_Run(t *testing.T) { assert.Equal(t, multistep.ActionContinue, action) } -func TestStepTransformBuildJSON_RunWithScriptConfigured(t *testing.T) { +func TestStepTransformBuildJSON_RunWithExecutableConfigured(t *testing.T) { cfg := config.ProviderConfigFromMap(map[string]string{ - "FILTER_JOB_JSON_SCRIPT": "/usr/local/bin/filter.py", + "PAYLOAD_FILTER_EXECUTABLE": "/usr/local/bin/filter.py", }) s, state := setupStepTransformBuildJSON(cfg)