Merge pull request #237 from jaedle/v3

Remove all code related support of version 1

cmd/task/task.go

@@ -28,6 +28,8 @@ Example: 'task hello' with the following 'Taskfile.yml' file will generate an
 'output.txt' file with the content "hello".
 
 '''
+version: '3'
+tasks:
   hello:
     cmds:
       - echo "I am going to write a file named 'output.txt' now."

docs/taskfile_versions.md

@@ -15,6 +15,8 @@ available, but not `3.0.0+`.
 
 ## Version 1
 
+*Taskfiles with Version `1` are not available on Task >= `v3.0.0` anymore.*
+
 In the first version of the `Taskfile`, the `version:` key was not available,
 because the tasks was in the root of the YAML document. Like this:
 

init.go

@@ -10,7 +10,7 @@ import (
 
 const defaultTaskfile = `# https://taskfile.dev
 
-version: '2'
+version: '3'
 
 vars:
   GREETING: Hello, World!

internal/compiler/v1/compiler_v1.go

@@ -1,137 +0,0 @@
-package v1
-
-import (
-	"bytes"
-	"context"
-	"fmt"
-	"strings"
-	"sync"
-
-	"github.com/go-task/task/v2/internal/compiler"
-	"github.com/go-task/task/v2/internal/execext"
-	"github.com/go-task/task/v2/internal/logger"
-	"github.com/go-task/task/v2/internal/taskfile"
-	"github.com/go-task/task/v2/internal/templater"
-)
-
-var _ compiler.Compiler = &CompilerV1{}
-
-type CompilerV1 struct {
-	Dir  string
-	Vars taskfile.Vars
-
-	Logger *logger.Logger
-
-	dynamicCache   map[string]string
-	muDynamicCache sync.Mutex
-}
-
-// GetVariables returns fully resolved variables following the priority order:
-// 1. Call variables (should already have been resolved)
-// 2. Environment (should not need to be resolved)
-// 3. Task variables, resolved with access to:
-//    - call, taskvars and environment variables
-// 4. Taskvars variables, resolved with access to:
-//    - environment variables
-func (c *CompilerV1) GetVariables(t *taskfile.Task, call taskfile.Call) (taskfile.Vars, error) {
-	merge := func(dest taskfile.Vars, srcs ...taskfile.Vars) {
-		for _, src := range srcs {
-			for k, v := range src {
-				dest[k] = v
-			}
-		}
-	}
-	varsKeys := func(srcs ...taskfile.Vars) []string {
-		m := make(map[string]struct{})
-		for _, src := range srcs {
-			for k := range src {
-				m[k] = struct{}{}
-			}
-		}
-		lst := make([]string, 0, len(m))
-		for k := range m {
-			lst = append(lst, k)
-		}
-		return lst
-	}
-	replaceVars := func(dest taskfile.Vars, keys []string) error {
-		r := templater.Templater{Vars: dest}
-		for _, k := range keys {
-			v := dest[k]
-			dest[k] = taskfile.Var{
-				Static: r.Replace(v.Static),
-				Sh:     r.Replace(v.Sh),
-			}
-		}
-		return r.Err()
-	}
-	resolveShell := func(dest taskfile.Vars, keys []string) error {
-		for _, k := range keys {
-			v := dest[k]
-			static, err := c.HandleDynamicVar(v)
-			if err != nil {
-				return err
-			}
-			dest[k] = taskfile.Var{Static: static}
-		}
-		return nil
-	}
-	update := func(dest taskfile.Vars, srcs ...taskfile.Vars) error {
-		merge(dest, srcs...)
-		// updatedKeys ensures template evaluation is run only once.
-		updatedKeys := varsKeys(srcs...)
-		if err := replaceVars(dest, updatedKeys); err != nil {
-			return err
-		}
-		return resolveShell(dest, updatedKeys)
-	}
-
-	// Resolve taskvars variables to "result" with environment override variables.
-	override := compiler.GetEnviron()
-	result := make(taskfile.Vars, len(c.Vars)+len(t.Vars)+len(override))
-	if err := update(result, c.Vars, override); err != nil {
-		return nil, err
-	}
-	// Resolve task variables to "result" with environment and call override variables.
-	merge(override, call.Vars)
-	if err := update(result, t.Vars, override); err != nil {
-		return nil, err
-	}
-	return result, nil
-}
-
-func (c *CompilerV1) HandleDynamicVar(v taskfile.Var) (string, error) {
-	if v.Static != "" || v.Sh == "" {
-		return v.Static, nil
-	}
-
-	c.muDynamicCache.Lock()
-	defer c.muDynamicCache.Unlock()
-
-	if c.dynamicCache == nil {
-		c.dynamicCache = make(map[string]string, 30)
-	}
-	if result, ok := c.dynamicCache[v.Sh]; ok {
-		return result, nil
-	}
-
-	var stdout bytes.Buffer
-	opts := &execext.RunCommandOptions{
-		Command: v.Sh,
-		Dir:     c.Dir,
-		Stdout:  &stdout,
-		Stderr:  c.Logger.Stderr,
-	}
-	if err := execext.RunCommand(context.Background(), opts); err != nil {
-		return "", fmt.Errorf(`task: Command "%s" in taskvars file failed: %s`, opts.Command, err)
-	}
-
-	// Trim a single trailing newline from the result to make most command
-	// output easier to use in shell commands.
-	result := strings.TrimSuffix(stdout.String(), "\n")
-
-	c.dynamicCache[v.Sh] = result
-	c.Logger.VerboseErrf(logger.Magenta, `task: dynamic variable: '%s' result: '%s'`, v.Sh, result)
-
-	return result, nil
-}

internal/taskfile/taskfile.go

@@ -13,11 +13,6 @@ type Taskfile struct {
 
 // UnmarshalYAML implements yaml.Unmarshaler interface
 func (tf *Taskfile) UnmarshalYAML(unmarshal func(interface{}) error) error {
-	if err := unmarshal(&tf.Tasks); err == nil {
-		tf.Version = "1"
-		return nil
-	}
-
 	var taskfile struct {
 		Version    string
 		Expansions int

task.go

@@ -11,7 +11,6 @@ import (
 	"sync/atomic"
 
 	"github.com/go-task/task/v2/internal/compiler"
-	compilerv1 "github.com/go-task/task/v2/internal/compiler/v1"
 	compilerv2 "github.com/go-task/task/v2/internal/compiler/v2"
 	"github.com/go-task/task/v2/internal/execext"
 	"github.com/go-task/task/v2/internal/logger"
@@ -122,14 +121,16 @@ func (e *Executor) Setup() error {
 	if err != nil {
 		return fmt.Errorf(`task: Could not parse taskfile version "%s": %v`, e.Taskfile.Version, err)
 	}
+
+	if v < 2 {
+		return fmt.Errorf(`task: Taskfile versions prior to v2 are not supported anymore`)
+	}
+
 	// consider as equal to the greater version if round
 	if v == 2.0 {
 		v = 2.6
 	}
 
-	if v < 1 {
-		return fmt.Errorf(`task: Taskfile version should be greater or equal to v1`)
-	}
 	if v > 3.0 {
 		return fmt.Errorf(`task: Taskfile versions greater than v3.0 not implemented in the version of Task`)
 	}
@@ -139,13 +140,6 @@ func (e *Executor) Setup() error {
 		e.Logger.Color = false
 	}
 
-	if v < 2 {
-		e.Compiler = &compilerv1.CompilerV1{
-			Dir:    e.Dir,
-			Vars:   e.taskvars,
-			Logger: e.Logger,
-		}
-	} else { // v >= 2
 	e.Compiler = &compilerv2.CompilerV2{
 		Dir:          e.Dir,
 		Taskvars:     e.taskvars,
@@ -153,7 +147,6 @@ func (e *Executor) Setup() error {
 		Expansions:   e.Taskfile.Expansions,
 		Logger:       e.Logger,
 	}
-	}
 
 	if v < 2.1 && e.Taskfile.Output != "" {
 		return fmt.Errorf(`task: Taskfile option "output" is only available starting on Taskfile version v2.1`)

task_test.go

@@ -69,43 +69,6 @@ func TestEnv(t *testing.T) {
 	tt.Run(t)
 }
 
-func TestVarsV1(t *testing.T) {
-	tt := fileContentTest{
-		Dir:       "testdata/vars/v1",
-		Target:    "default",
-		TrimSpace: true,
-		Files: map[string]string{
-			// hello task:
-			"foo.txt":              "foo",
-			"bar.txt":              "bar",
-			"baz.txt":              "baz",
-			"tmpl_foo.txt":         "foo",
-			"tmpl_bar.txt":         "<no value>",
-			"tmpl_foo2.txt":        "foo2",
-			"tmpl_bar2.txt":        "bar2",
-			"shtmpl_foo.txt":       "foo",
-			"shtmpl_foo2.txt":      "foo2",
-			"nestedtmpl_foo.txt":   "{{.FOO}}",
-			"nestedtmpl_foo2.txt":  "foo2",
-			"foo2.txt":             "foo2",
-			"bar2.txt":             "bar2",
-			"baz2.txt":             "baz2",
-			"tmpl2_foo.txt":        "<no value>",
-			"tmpl2_foo2.txt":       "foo2",
-			"tmpl2_bar.txt":        "<no value>",
-			"tmpl2_bar2.txt":       "<no value>",
-			"shtmpl2_foo.txt":      "<no value>",
-			"shtmpl2_foo2.txt":     "foo2",
-			"nestedtmpl2_foo2.txt": "{{.FOO2}}",
-			"override.txt":         "bar",
-		},
-	}
-	tt.Run(t)
-	// Ensure identical results when running hello task directly.
-	tt.Target = "hello"
-	tt.Run(t)
-}
-
 func TestVarsV2(t *testing.T) {
 	tt := fileContentTest{
 		Dir:       "testdata/vars/v2",
@@ -144,7 +107,7 @@ func TestVarsV2(t *testing.T) {
 }
 
 func TestMultilineVars(t *testing.T) {
-	for _, dir := range []string{"testdata/vars/v1/multiline", "testdata/vars/v2/multiline"} {
+	for _, dir := range []string{"testdata/vars/v2/multiline"} {
 		tt := fileContentTest{
 			Dir:       dir,
 			Target:    "default",
@@ -168,7 +131,7 @@ func TestMultilineVars(t *testing.T) {
 
 func TestVarsInvalidTmpl(t *testing.T) {
 	const (
-		dir         = "testdata/vars/v1"
+		dir         = "testdata/vars/v2"
 		target      = "invalid-var-tmpl"
 		expectError = "template: :1: unexpected EOF"
 	)
@@ -441,7 +404,6 @@ func TestTaskVersion(t *testing.T) {
 		Dir     string
 		Version string
 	}{
-		{"testdata/version/v1", "1"},
 		{"testdata/version/v2", "2"},
 	}
 
@@ -678,3 +640,15 @@ func TestWhenDirAttributeItCreatesMissingAndRunsInThatDir(t *testing.T) {
 	// Clean-up after ourselves only if no error.
 	_ = os.Remove(toBeCreated)
 }
+
+func TestDisplaysErrorOnUnsupportedVersion(t *testing.T) {
+	e := task.Executor{
+		Dir:    "testdata/version/v1",
+		Stdout: ioutil.Discard,
+		Stderr: ioutil.Discard,
+	}
+	err := e.Setup()
+	assert.Error(t, err)
+	assert.Equal(t, "task: Taskfile versions prior to v2 are not supported anymore", err.Error())
+
+}

testdata/checksum/Taskfile.yml

@@ -1,3 +1,6 @@
+version: '2'
+
+tasks:
   build:
     cmds:
       - cp ./source.txt ./generated.txt

testdata/cyclic/Taskfile.yml

@@ -1,3 +1,6 @@
+version: '2'
+
+tasks:
   task-1:
     deps:
       - task: task-2

testdata/deps/Taskfile.yml

@@ -1,3 +1,6 @@
+version: '2'
+
+tasks:
   default:
     deps: [d1, d2, d3]
 

testdata/generates/Taskfile.yml

@@ -1,3 +1,6 @@
+version: '2'
+
+tasks:
   abs.txt:
     desc: generates dest file based on absolute paths
     deps:

testdata/params/Taskfile.yml

@@ -1,3 +1,6 @@
+version: '2'
+
+tasks:
   default:
     vars:
       SPANISH: ¡Holla mundo!

testdata/status/Taskfile.yml

@@ -1,3 +1,6 @@
+version: '2'
+
+tasks:
   gen-foo:
     cmds:
       - touch foo.txt

testdata/summary/Taskfile.yml

@@ -1,4 +1,4 @@
-version: 2
+version: '2'
 
 tasks:
   task-with-summary:

testdata/vars/v1/.gitignore

@@ -1 +0,0 @@
-*.txt

testdata/vars/v1/Taskfile.yml

@@ -1,48 +0,0 @@
-default:
-  deps: [hello]
-
-hello:
-  cmds:
-    - echo {{.FOO}} > foo.txt
-    - echo {{.BAR}} > bar.txt
-    - echo {{.BAZ}} > baz.txt
-    - echo '{{.TMPL_FOO}}' > tmpl_foo.txt
-    - echo '{{.TMPL_BAR}}' > tmpl_bar.txt
-    - echo '{{.TMPL_FOO2}}' > tmpl_foo2.txt
-    - echo '{{.TMPL_BAR2}}' > tmpl_bar2.txt
-    - echo '{{.SHTMPL_FOO}}' > shtmpl_foo.txt
-    - echo '{{.SHTMPL_FOO2}}' > shtmpl_foo2.txt
-    - echo '{{.NESTEDTMPL_FOO}}' > nestedtmpl_foo.txt
-    - echo '{{.NESTEDTMPL_FOO2}}' > nestedtmpl_foo2.txt
-    - echo {{.FOO2}} > foo2.txt
-    - echo {{.BAR2}} > bar2.txt
-    - echo {{.BAZ2}} > baz2.txt
-    - echo '{{.TMPL2_FOO}}' > tmpl2_foo.txt
-    - echo '{{.TMPL2_BAR}}' > tmpl2_bar.txt
-    - echo '{{.TMPL2_FOO2}}' > tmpl2_foo2.txt
-    - echo '{{.TMPL2_BAR2}}' > tmpl2_bar2.txt
-    - echo '{{.SHTMPL2_FOO}}' > shtmpl2_foo.txt
-    - echo '{{.SHTMPL2_FOO2}}' > shtmpl2_foo2.txt
-    - echo '{{.NESTEDTMPL2_FOO2}}' > nestedtmpl2_foo2.txt
-    - echo {{.OVERRIDE}} > override.txt
-  vars:
-    FOO: foo
-    BAR: $echo bar
-    BAZ:
-      sh: echo baz
-    TMPL_FOO: "{{.FOO}}"
-    TMPL_BAR: "{{.BAR}}"
-    TMPL_FOO2: "{{.FOO2}}"
-    TMPL_BAR2: "{{.BAR2}}"
-    SHTMPL_FOO:
-      sh: "echo '{{.FOO}}'"
-    SHTMPL_FOO2:
-      sh: "echo '{{.FOO2}}'"
-    NESTEDTMPL_FOO: "{{.TMPL_FOO}}"
-    NESTEDTMPL_FOO2: "{{.TMPL2_FOO2}}"
-    OVERRIDE: "bar"
-
-invalid-var-tmpl:
-  vars:
-    CHARS: "abcd"
-    INVALID: "{{range .CHARS}}no end"

testdata/vars/v1/Taskvars.yml

@@ -1,12 +0,0 @@
-FOO2: foo2
-BAR2: $echo bar2
-BAZ2:
-  sh: echo baz2
-TMPL2_FOO: "{{.FOO}}"
-TMPL2_BAR: "{{.BAR}}"
-TMPL2_FOO2: "{{.FOO2}}"
-TMPL2_BAR2: "{{.BAR2}}"
-SHTMPL2_FOO2:
-  sh: "echo '{{.FOO2}}'"
-NESTEDTMPL2_FOO2: "{{.TMPL2_FOO2}}"
-OVERRIDE: "foo"

testdata/vars/v1/multiline/Taskfile.yml

@@ -1,43 +0,0 @@
-default:
-  vars:
-    MULTILINE: "\n\nfoo\n  bar\nfoobar\n\nbaz\n\n"
-  cmds:
-    - task: file
-      vars:
-        CONTENT:
-          sh: "echo 'foo\nbar'"
-        FILE: "echo_foobar.txt"
-    - task: file
-      vars:
-        CONTENT:
-          sh: "echo -n 'foo\nbar'"
-        FILE: "echo_n_foobar.txt"
-    - task: file
-      vars:
-        CONTENT:
-          sh: echo -n "{{.MULTILINE}}"
-        FILE: "echo_n_multiline.txt"
-    - task: file
-      vars:
-        CONTENT: "{{.MULTILINE}}"
-        FILE: "var_multiline.txt"
-    - task: file
-      vars:
-        CONTENT: "{{.MULTILINE | catLines}}"
-        FILE: "var_catlines.txt"
-    - task: enumfile
-      vars:
-        LINES: "{{.MULTILINE}}"
-        FILE: "var_enumfile.txt"
-file:
-  cmds:
-    - |
-      cat << EOF > '{{.FILE}}'
-      {{.CONTENT}}
-      EOF
-enumfile:
-  cmds:
-    - |
-      cat << EOF > '{{.FILE}}'
-      {{range $i, $line := .LINES| splitLines}}{{$i}}:{{$line}}
-      {{end}}EOF

testdata/version/v2/Taskfile.yml

@@ -1,9 +1,9 @@
-version: 2
+version: '2'
+
 tasks:
   foo:
     cmds:
       - echo "Foo"
-
   bar:
     cmds:
       - echo "Bar"