Merge pull request #33 from kudulab/golang-1.17.7

Golang 1.17.7

Author: Ava Czechowska

.circleci/config.yml

@@ -47,16 +47,14 @@ jobs:
       - run:
           name: Install dojo
           command: |
-            version="0.10.3"
+            version="0.10.5"
             wget -O /tmp/dojo https://github.com/kudulab/dojo/releases/download/${version}/dojo_linux_amd64
             chmod +x /tmp/dojo
             sudo mv /tmp/dojo /usr/bin/dojo
       - run:
-          command: dojo -c Dojofile.build "./tasks deps"
+          command: /bin/bash -c "./tasks build"
       - run:
-          command: dojo -c Dojofile.build "./tasks build"
-      - run:
-          command: dojo -c Dojofile.build "./tasks unit"
+          command: /bin/bash -c "./tasks unit"
       - run:
           command: /bin/bash -c "./tasks symlink linux"
       - persist_to_workspace:
@@ -71,7 +69,7 @@ jobs:
       - run:
           name: Install dojo
           command: |
-            version="0.10.3"
+            version="0.10.5"
             wget -O /tmp/dojo https://github.com/kudulab/dojo/releases/download/${version}/dojo_linux_amd64
             chmod +x /tmp/dojo
             sudo mv /tmp/dojo /usr/bin/dojo
@@ -89,7 +87,7 @@ jobs:
       - run:
           name: Install dojo
           command: |
-            version="0.10.3"
+            version="0.10.5"
             wget -O /tmp/dojo https://github.com/kudulab/dojo/releases/download/${version}/dojo_linux_amd64
             chmod +x /tmp/dojo
             sudo mv /tmp/dojo /usr/bin/dojo

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.11.0 (2022-Feb-27)
+
+* Compile Dojo using Golang 1.17.7 thanks to using Docker image kudulab/golang-dojo:2.0.0
+
 ### 0.10.5 (2022-Feb-20)
 
 * Update a log message in entrypoint about sourcing the scripts

Dojofile.build

@@ -1,3 +1,2 @@
-DOJO_DOCKER_IMAGE=kudulab/golang-dojo:1.1.1
-DOJO_WORK_INNER="/dojo/work/src/dojo"
+DOJO_DOCKER_IMAGE=kudulab/golang-dojo:2.0.0
 DOJO_DOCKER_OPTIONS="--security-opt seccomp:unconfined"

README.md

@@ -35,7 +35,7 @@ Dojo works on **Linux or Mac**. Dojo is continuously tested only on Linux.
     * [Handling signals](#handling-signals)
 1. [FAQ](#faq)
 1. [Comparison to other tools](#comparison-to-other-tools)
-1. [Development](#Development)
+1. [Contributing and Development](#contributing-and-development)
 1. [License](#License)
 
 ## Installation
@@ -112,7 +112,7 @@ Let's build this project (Dojo) using `dojo`:
 ```bash
 git clone https://github.com/kudulab/dojo.git
 cd dojo
-dojo -c Dojofile.build "./tasks deps && ./tasks build"
+dojo -c Dojofile.build "./tasks build"
 ```
 
 Here we used Dojo flag `-c Dojofile.build`. This way we instructed dojo CLI which Dojofile to use. Dojofile keeps information about the Docker Image. [Dojofile.build](https://github.com/kudulab/dojo/blob/master/Dojofile.build) uses [kudulab/golang-dojo](https://github.com/kudulab/docker-golang-dojo) Docker image.
@@ -123,7 +123,7 @@ There are also Dojo Docker images which bundle a tool (or group of tools), e.g.
 ```
 $ nano Dojofile
 $ cat Dojofile
-DOJO_DOCKER_IMAGE="kudulab/aws-dojo:0.6.0"
+DOJO_DOCKER_IMAGE="kudulab/aws-dojo:0.7.0"
 $ dojo
 # now we run interactively in the Dojo Docker container
 dojo@407490ab35cb(aws-dojo):/dojo/work$ aws ec2 describe-instances --filters "Name=tag:Name,Values=ec2-ansible-test"
@@ -861,25 +861,70 @@ If we extend this concept, then we soon realize that the project did not define
 In any sensible organization, configuration management is used to provision the CI-agents and developer's workstation building the project. It is one level better than the README, but still the definition of the environment exists outside the project and there is no reference to it.
 The `Dojofile` is the *lock* file which allows to store this reference in source control. When you run `dojo <command>`, then the environment is fetched, just like a dependency manager would fetch all dependencies of the project.
 
-## Development
-Run these commands in `dojo` (use previous version of dojo to build a next one):
+## Contributing and Development
+
+Instructions how to update this project.
+
+1. Create a new feature branch from the `master` branch
+2. Work on your changes in that feature branch. If you want, describe you changes in [CHANGELOG.md](CHANGELOG.md)
+3. Compile the code and run tests locally, see the [2 options](#2-options-to-develop-Dojo) below
+4. If you are happy with the results, create a PR from your feature branch to the main branch
+
+After this, someone will read your PR, merge it and ensure version bump (using `./tasks set_version`). CI pipeline will run to automatically build and test docker image, release the project and publish the docker image.
+
+### 2 options to develop Dojo
+You may either use Dojo to develop Dojo, or use your local environment
+
+You may take a look at the [CICD pipeline config](.circleci/config.yml) and at the [tasks](tasks) file. The tasks file has the same purpose as Makefile or Rakefile.
+
+#### Option 1: Using Dojo to develop Dojo
+1. Please ensure you have the [runtime dependencies](#dependencies) installed
+2. Please install [Dojo](#installation)
+3. Compile the code and run unit tests:
 ```
-./tasks deps
-./tasks build
-./tasks unit
+$ dojo -c Dojofile.build
+./tasks _build
+./tasks _unit
+./tasks symlink linux
+# or instead, if you're running on Mac: ./tasks symlink darwin
 ```
 
-Run integration tests, (this uses [inception-dojo](https://github.com/kudulab/docker-inception-dojo) docker image):
+  or
+  ```
+  ./tasks build
+  ./tasks unit
+
+  ./tasks symlink linux
+  # or instead, if you're running on Mac: ./tasks symlink darwin
+  ```
+
+4. Run end to end tests:
 ```
-./tasks symlink linux
-# or instead, if you're running on Mac: ./tasks symlink linux
-./tasks e2e alpine
 ./tasks e2e ubuntu18
+./tasks e2e alpine
 ```
 
+#### Option 2: Using local environment to develop Dojo
+1. Please ensure you have the [runtime dependencies](#dependencies) installed
+2. Please install the development dependencies:
+  * Golang
+  * Python
+
+3. Now you can compile and test Dojo:
+
+  ```
+  ./tasks _build
+  ./tasks _unit
+
+  ./tasks symlink linux
+  # or instead, if you're running on Mac: ./tasks symlink darwin
+  ./tasks _e2e
+  ```
+
+
 ## License
 
-Copyright 2019 Ewa Czechowska, Tomasz Sętkowski
+Copyright 2019-2022 Ava Czechowska, Tom Setkowski
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

config_test.go

@@ -248,13 +248,18 @@ func Test_getMergedConfig(t *testing.T){
 		DockerImage: "img",
 	}
 	config3 := getDefaultConfig("somefile")
+	currentDirectory, err := os.Getwd()
+	if err != nil {
+		panic(err)
+	}
+
 	mergedConfig := getMergedConfig(config1, config2, config3)
 	assert.Equal(t, "dummy", mergedConfig.Action)
 	assert.Equal(t, "somefile", mergedConfig.ConfigFile)
 	assert.Equal(t, "false", mergedConfig.Debug)
 	assert.Equal(t, "mydriver", mergedConfig.Driver)
 	assert.Equal(t, "true", mergedConfig.RemoveContainers)
-	assert.Contains(t, mergedConfig.WorkDirOuter, "/src/dojo")
+	assert.Contains(t, mergedConfig.WorkDirOuter, currentDirectory)
 	assert.Equal(t, "/dojo/work", mergedConfig.WorkDirInner)
 	assert.Equal(t, "/tmp/myhome", mergedConfig.IdentityDirOuter)
 	assert.Equal(t, "img", mergedConfig.DockerImage)

glide.lock

@@ -0,0 +1,11 @@
+module github.com/kudulab/dojo
+
+go 1.17
+
+require github.com/stretchr/testify v1.7.0
+
+require (
+	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+)

glide.yaml

@@ -0,0 +1,11 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.mod

@@ -34,16 +34,16 @@ function setup_github_credentials {
 
 command="$1"
 case "${command}" in
-    deps)
-        glide install
-        ;;
-    build)
+    _build)
         rm -rf bin/dojo
         # disable the use of cgo with: CGO_ENABLED=0
         (set -x; GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 go build -o bin/dojo_darwin_amd64 ./; )
         (set -x; GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o bin/dojo_linux_amd64 ./; )
         # to get a list supported golang platforms: go tool dist list
         ;;
+    build)
+        dojo -c Dojofile.build "./tasks _build"
+        ;;
     symlink)
         if [[ -n "$2" ]]; then
           os_suffix=$2
@@ -56,24 +56,26 @@ case "${command}" in
         ln -s dojo_${os_suffix}_amd64 ./bin/dojo
         chmod +x ./bin/dojo
         ;;
-    unit)
+    _unit)
         (set -x; go test -v -race ./... | sed ''/PASS/s//$(printf "\033[32mPASS\033[0m")/'' | sed ''/FAIL/s//$(printf "\033[31mFAIL\033[0m")/''; )
         ;;
-    e2e_py)
-        echo "Running task: e2e_py"
+    unit)
+        dojo -c Dojofile.build "./tasks _unit"
+        ;;
+    _e2e)
+        echo "Running task: e2e"
+        if [[ ! -f "bin/dojo" ]]; then
+          echo "Error: File bin/dojo not found. Please run either './tasks symlink linux' or ./tasks symlink darwin' depending on your OS"
+          exit 1
+        fi
         python3 -m venv venv
         source venv/bin/activate
         pip3 install -r test/requirements.txt
         pytest test --verbose
         ;;
-    e2e_invalid_environment)
-        echo "Running task: e2e_invalid_environment"
-        docker run -t --rm -v ${PWD}/bin/dojo:/usr/bin/dojo alpine:3.15 "/usr/bin/dojo" 2>&1 | grep "Error while verifying if Bash is installed" && true
-        ;;
     e2e)
         check_flavor $2
-        dojo -c Dojofile.e2e-$2 "./tasks e2e_py"
-        ./tasks e2e_invalid_environment
+        dojo -c Dojofile.e2e-$2 "./tasks _e2e"
         ;;
     test_signals)
         check_flavor $2