Remove the convey/extend task as it's normal usage is already covered by plan/stage environment variables. It's corner case, expanding variables, is rather exotic and not something that comes up often.
--- a/ChangeLog Sat Oct 26 13:45:42 2019 -0500
+++ b/ChangeLog Sat Oct 26 13:53:24 2019 -0500
@@ -33,6 +33,8 @@
--list-meta-plans, --list-plans, --list-tasks, and --config.
* Removed the network since it doesn't actually protect the host from the
+ * Removed the convey/extend task as it's very normal case is easily + replicated by plan/stage environment variables. * Write warning, error, and fatal log messages to stderr. Fixed #156
--- a/go.mod Sat Oct 26 13:45:42 2019 -0500
+++ b/go.mod Sat Oct 26 13:53:24 2019 -0500
@@ -14,7 +14,6 @@
github.com/mattn/go-colorable v0.1.2 // indirect
github.com/mattn/go-zglob v0.0.1
github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b
- github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 github.com/philopon/go-toposort v0.0.0-20170620085441-9be86dbd762f
github.com/satori/go.uuid v1.2.0
github.com/sirupsen/logrus v1.4.1
--- a/go.sum Sat Oct 26 13:45:42 2019 -0500
+++ b/go.sum Sat Oct 26 13:53:24 2019 -0500
@@ -32,8 +32,6 @@
github.com/mattn/go-zglob v0.0.1/go.mod h1:9fxibJccNxU2cnpIKLRRFA7zX7qhkJIQWBb449FYHOo=
github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b h1:j7+1HpAFS1zy5+Q4qx1fWh90gTKwiN4QCGoY9TWyyO4=
github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
-github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw=-github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8= github.com/philopon/go-toposort v0.0.0-20170620085441-9be86dbd762f h1:WyCn68lTiytVSkk7W1K9nBiSGTSRlUOdyTnSjwrIlok=
github.com/philopon/go-toposort v0.0.0-20170620085441-9be86dbd762f/go.mod h1:/iRjX3DdSK956SzsUdV55J+wIsQ+2IBWmBrB4RvZfk4=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
--- a/loaders/convey/extend_test.go Sat Oct 26 13:45:42 2019 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,442 +0,0 @@
-// Copyright 2016-2018 Gary Kramlich <grim@reaperworld.com>-// This program is free software: you can redistribute it and/or modify-// it under the terms of the GNU General Public License as published by-// the Free Software Foundation, either version 3 of the License, or-// (at your option) any later version.-// This program is distributed in the hope that it will be useful,-// but WITHOUT ANY WARRANTY; without even the implied warranty of-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the-// GNU General Public License for more details.-// You should have received a copy of the GNU General Public License-// along with this program. If not, see <http://www.gnu.org/licenses/>.- "github.com/stretchr/testify/assert"- cConfig "bitbucket.org/rw_grim/convey/config"- "bitbucket.org/rw_grim/convey/tasks"-// This test suite tests-func TestExtendSimple(t *testing.T) {- cfg, err := loader.Load(".", ".", []byte(data), []string{}, true)- assert.Len(t, cfg.Tasks, 2)- assert.Contains(t, cfg.Tasks, "a")- assert.Contains(t, cfg.Tasks, "b")- assert.Exactly(t, cfg.Tasks["b"].(*tasks.Extend).InnerTask, cfg.Tasks["a"])-func TestExtendChain(t *testing.T) {- cfg, err := loader.Load(".", ".", []byte(data), []string{}, true)- assert.Len(t, cfg.Tasks, 3)- assert.Contains(t, cfg.Tasks, "a")- assert.Contains(t, cfg.Tasks, "b")- assert.Contains(t, cfg.Tasks, "c")- cfg.Tasks["c"].(*tasks.Extend).InnerTask,- cfg.Tasks["b"].(*tasks.Extend).InnerTask,- cfg.Tasks["c"].(*tasks.Extend).InnerTask.(*tasks.Extend).InnerTask,-func TestExtendCycle(t *testing.T) {- _, err := loader.Load(".", ".", []byte(data), []string{}, true)- "The following tasks are part of a dependency cycle: a, b",-func TestExtendMissingTask(t *testing.T) {- _, err := loader.Load(".", ".", []byte(data), []string{}, true)- assert.EqualError(t, err, "b: Extending undeclared task 'a'")-func TestExtendExtends(t *testing.T) {- fileLoader: func(name string, c *Loader) (*cConfig.Config, error) {- return c.Load(".", name, []byte(baseData), []string{}, true)- cfg, err := loader.Load(".", ".", []byte(extendedData), []string{}, true)- assert.Len(t, cfg.Tasks, 2)- assert.Contains(t, cfg.Tasks, "foo")- assert.Contains(t, cfg.Tasks, "bar")- cfg.Tasks["bar"].(*tasks.Extend).InnerTask,-func TestReplaceStage(t *testing.T) {- fileLoader: func(name string, c *Loader) (*cConfig.Config, error) {- m := map[string]string{- return c.Load(".", name, []byte(m[name]), []string{}, true)- cfg, err := loader.Load(".", ".", []byte(data3), []string{}, true)- assert.Len(t, cfg.Plans, 2)- assert.Contains(t, cfg.Plans, "plan1")- assert.Contains(t, cfg.Plans, "plan2")- assert.Len(t, cfg.Plans["plan1"].Stages, 3)- assert.Equal(t, cfg.Plans["plan1"].Stages[0].Name, "pre")- assert.Equal(t, cfg.Plans["plan1"].Stages[1].Name, "real-work")- assert.Equal(t, cfg.Plans["plan1"].Stages[2].Name, "post")- assert.Len(t, cfg.Plans["plan1"].Stages[0].Tasks, 1)- assert.Len(t, cfg.Plans["plan1"].Stages[1].Tasks, 1)- assert.Len(t, cfg.Plans["plan1"].Stages[2].Tasks, 1)- cfg.Plans["plan1"].Stages[0].Tasks,- cfg.Plans["plan1"].Stages[1].Tasks,- cfg.Plans["plan1"].Stages[2].Tasks,- assert.Len(t, cfg.Plans["plan2"].Stages, 1)- assert.Len(t, cfg.Plans["plan2"].Stages[0].Tasks, 1)- cfg.Plans["plan2"].Stages[0].Tasks,-func TestMergeMissingPlan(t *testing.T) {- fileLoader: func(name string, c *Loader) (*cConfig.Config, error) {- return c.Load(".", name, []byte(data1), []string{}, true)- _, err := loader.Load(".", ".", []byte(data2), []string{}, true)- assert.EqualError(t, err, "cannot merge with unknown plan 'plan2'")-func TestMergeMissingStage(t *testing.T) {- fileLoader: func(name string, c *Loader) (*cConfig.Config, error) {- return c.Load(".", name, []byte(data1), []string{}, true)- _, err := loader.Load(".", ".", []byte(data2), []string{}, true)- "cannot overwrite stage 'missing' in plan 'plan1' (no such stage in parent)",-func TestMergePlanEnvironment(t *testing.T) {- fileLoader: func(name string, c *Loader) (*cConfig.Config, error) {- return c.Load(".", name, []byte(data1), []string{}, true)- cfg, err := loader.Load(".", ".", []byte(data2), []string{}, true)- cfg.Plans["plan1"].Stages[0].Tasks,- cfg.Plans["plan1"].Environment,- []string{"FOO=BAR", "BAR=BONK"},--- a/tasks/README.md Sat Oct 26 13:45:42 2019 -0500
+++ b/tasks/README.md Sat Oct 26 13:53:24 2019 -0500
@@ -23,54 +23,6 @@
-An convey/extend task overrides the environment of another task.-| Name | Required | Default | Description |-| ---------------- | -------- | ------- | ----------- |-| environment | | | The override environment |-| expand | | | The envvars which can be expanded into lists on use |-| expand_delimiter | | ; | The string to split mapped values by |-| task | Yes | | The name of the task to extend |-The `expand` and `expand_delimiter` attributes allow an environment variable, which is an unstructured string, to act as if it is an array. This is useful for supplying an "abstract" parent task with several arguments for the same attribute (e.g. tags in a build task). Variables that occur in the environment with a name in expand will be split by the expand delimiter to form a list, where applicable.- image: gliderlabs/alpine:edge- - MESSAGE="Hello, World"-### Example with Variable Expansion- source: gliderlabs/alpine:edge-----
A noop task does nothing. It is a "No Operation" task. It's used primarily in
--- a/tasks/extend.go Sat Oct 26 13:45:42 2019 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,95 +0,0 @@
-// Copyright 2016-2018 Gary Kramlich <grim@reaperworld.com>-// This program is free software: you can redistribute it and/or modify-// it under the terms of the GNU General Public License as published by-// the Free Software Foundation, either version 3 of the License, or-// (at your option) any later version.-// This program is distributed in the hope that it will be useful,-// but WITHOUT ANY WARRANTY; without even the implied warranty of-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the-// GNU General Public License for more details.-// You should have received a copy of the GNU General Public License-// along with this program. If not, see <http://www.gnu.org/licenses/>.- "github.com/mohae/deepcopy"- log "github.com/sirupsen/logrus"- "bitbucket.org/rw_grim/convey/environment"- "bitbucket.org/rw_grim/convey/runtime"- "bitbucket.org/rw_grim/convey/yaml"-// Extend represents a task that extends another task.- Environment yaml.StringOrSlice `yaml:"environment"`- Expand yaml.StringOrSlice `yaml:"expand"`- ExpandDelimiter string `yaml:"expand_delimiter"`- Task string `yaml:"task"`- // A copy of the extended task. Must be public so that deepcopy- // can serialize it properly in case an extended task is extended- // itself (when private the innerTask is nil and causes a bad- // data access exception).-// Execute runs an extended task.-func (e *Extend) Execute(name string, logger *log.Entry, env *environment.Environment, rt *runtime.Runtime) error {- // While extending, certain environment variables can be expanded into- // lists. We store this meta information as a stack on the state, which- // is passed into the inner task execute method (and so on).- newRt := runtime.NewWithEnvironment(- environment.NewExpandable(- e.Expand, e.ExpandDelimiter,- environment.Merge(e.Environment, rt.Environment.Items())...,- return e.InnerTask.Execute(name, logger, env, newRt)-// New creates a new extend task.-func (e *Extend) New() Task {-// Valid validates the task.-func (e *Extend) Valid() error {- if e.ExpandDelimiter == "" {- e.ExpandDelimiter = ";"-// Dependencies returns a list of tasks that this task depends on.-func (e *Extend) Dependencies() []string {- return []string{e.Task}-// Resolve returns the fully extended task.-func (e *Extend) Resolve(taskMap map[string]Task) error {- task, ok := taskMap[e.Task]- // Should never happen due to dependency order- return fmt.Errorf("Extending undeclared task '%s'", e.Task)- // Some tasks may set their own fields, e.g. when mapping things- // to the correct runtime environment. In order to make sure that- // the inner task doesn't cache something from another run, we- // do a clone of the task here so we get our own copy to muck with.- e.InnerTask = deepcopy.Copy(task).(Task)--- a/tasks/extend_test.go Sat Oct 26 13:45:42 2019 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,163 +0,0 @@
-// Copyright 2016-2018 Gary Kramlich <grim@reaperworld.com>-// This program is free software: you can redistribute it and/or modify-// it under the terms of the GNU General Public License as published by-// the Free Software Foundation, either version 3 of the License, or-// (at your option) any later version.-// This program is distributed in the hope that it will be useful,-// but WITHOUT ANY WARRANTY; without even the implied warranty of-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the-// GNU General Public License for more details.-// You should have received a copy of the GNU General Public License-// along with this program. If not, see <http://www.gnu.org/licenses/>.- log "github.com/sirupsen/logrus"- "github.com/stretchr/testify/assert"- "bitbucket.org/rw_grim/convey/environment"- "bitbucket.org/rw_grim/convey/runtime"- "bitbucket.org/rw_grim/convey/state"-func TestExtendExecute(t *testing.T) {- fullEnv = environment.New()- env := environment.New()- env.MergeSlice([]string{"bar=bonk", "quux=honk"})- rt := runtime.NewWithEnvironment(&state.State{}, env)- task.executeFn = func(name string, logger *log.Entry, env *environment.Environment, rt *runtime.Runtime) error {- fullEnv.Merge(env).MergeSlice([]string{"x=1", "foo=quux"}).Merge(rt.Environment)- Environment: []string{"foo=bar", "bar=baz"},- assert.Nil(t, c.Execute("task", nil, environment.New(), rt))- assert.Len(t, fullEnv.Items(), 4)- []string{"x=1", "foo=bar", "bar=bonk", "quux=honk"},- assert.Len(t, env.Items(), 2)- []string{"bar=bonk", "quux=honk"},-func TestExtendDependencies(t *testing.T) {- c := &Extend{Task: "test-task"}- assert.Equal(t, c.Dependencies(), []string{"test-task"})-func TestExtendResolve(t *testing.T) {- task.Y = []string{"foo", "bar"}- c := &Extend{Task: "a"}- err := c.Resolve(map[string]Task{- // Must clone inner task- assert.NotNil(t, c.InnerTask)- assert.NotEqual(t, c.InnerTask, task)- assert.Equal(t, c.InnerTask.(*mockTask).X, 3)- assert.Equal(t, c.InnerTask.(*mockTask).Y, []string{"foo", "bar"})- assert.Equal(t, c.InnerTask.(*mockTask).Z.A, "wynken")- assert.Equal(t, c.InnerTask.(*mockTask).Z.B, "blynken")- assert.Equal(t, c.InnerTask.(*mockTask).Z.C, "nod")-func TestExtendResolveChain(t *testing.T) {- task.Y = []string{"foo", "bar"}- c1 := &Extend{Task: "a"}- c2 := &Extend{Task: "b"}- taskMapping := map[string]Task{- assert.Nil(t, c1.Resolve(taskMapping))- assert.Nil(t, c2.Resolve(taskMapping))- // Must clone inner task- assert.NotNil(t, c2.InnerTask)- assert.NotNil(t, c2.InnerTask.(*Extend).InnerTask)- assert.Equal(t, c2.InnerTask.(*Extend).InnerTask.(*mockTask).X, 3)- c2.InnerTask.(*Extend).InnerTask.(*mockTask).Y,- []string{"foo", "bar"},- executeFn func(string, *log.Entry, *environment.Environment, *runtime.Runtime) error-func newMockTask() *mockTask {- executeFn: func(string, *log.Entry, *environment.Environment, *runtime.Runtime) error {-func (t *mockTask) Execute(name string, logger *log.Entry, env *environment.Environment, rt *runtime.Runtime) error {- return t.executeFn(name, logger, env, rt)-func (t *mockTask) New() Task {-func (t *mockTask) Valid() error {--- a/tasks/tasks.go Sat Oct 26 13:45:42 2019 -0500
+++ b/tasks/tasks.go Sat Oct 26 13:53:24 2019 -0500
@@ -29,7 +29,6 @@
