Improve path helper library

.circleci/config.yml

@@ -28,6 +28,18 @@ workflows:
       - integration-tests-gcp-ubuntu:
           requires:
             - build
+      - integration-tests-gcp-rhel:
+          requires:
+            - build
+      - release:
+          requires:
+            - build
+            - unit-tests
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /.*/
 
 jobs:
   build:
@@ -37,22 +49,25 @@ jobs:
       - setup_remote_docker
       - run: make
       - run: make lint
-      - deploy:
-          name: Push wksctl to S3
+      - run:
+          name: Check that generated files haven't been changed since checkout
           command: |
-            TAG=${CIRCLE_TAG}
-            if [ -z "$TAG" ]; then
-              TAG=$(./tools/image-tag)
-            fi
+            echo "The following files have been modified since checkout or are unknown to Git:"
+            ! (git status --porcelain | grep -E '^( M)|(??)')
       - persist_to_workspace:
           root: .
           paths:
           - kubectl
           - cmd/wksctl/wksctl
           - cmd/mock-https-authz-server/server
-      # - run: docker login -u "$DOCKER_USER" -p "$DOCKER_PASSWORD" quay.io
-      # - run: make push
-
+      - run:
+          # Allow builds from forks
+          name: Push image if quay login is available
+          command: |
+            if [ -n "$QUAY_IO_USER" -a -n "$QUAY_IO_PASSWORD" ]; then
+              docker login -u "$QUAY_IO_USER" -p "$QUAY_IO_PASSWORD" quay.io
+              make push
+            fi
   unit-tests:
     docker:
       - image: quay.io/wks/build:master-134af34f
@@ -77,6 +92,13 @@ jobs:
           command: |
             go version
             make unit-tests
+
+  release:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: curl -sL https://git.io/goreleaser | IMAGE_TAG=`tools/image-tag` bash
+
   container-tests:
     machine:
       docker_layer_caching: true
@@ -88,20 +110,19 @@ jobs:
       SRCDIR: /home/circleci/src/github.com/weaveworks/wksctl
     working_directory: /home/circleci/src/github.com/weaveworks/wksctl
     steps:
-      # - checkout
-      # - run:
-      #     name: Install go
-      #     command: |
-      #       (cd ~ && curl -L $GOURL -o go.tar.gz && echo "$GOCHECKSUM go.tar.gz" | sha256sum -c)
-      #       mkdir -p $GOROOT && tar xf ~/go.tar.gz -C $GOROOT --strip-components 1
+      - checkout
+      - run:
+          name: Install go
+          command: |
+            (cd ~ && curl -L $GOURL -o go.tar.gz && echo "$GOCHECKSUM go.tar.gz" | sha256sum -c)
+            mkdir -p $GOROOT && tar xf ~/go.tar.gz -C $GOROOT --strip-components 1
 
-      # - run:
-      #     name: Run container tests
-      #     command: |
-      #       export PATH=$GOROOT/bin:$PATH
-      #       go version
-      #       make container-tests
-      - run: "true"
+      - run:
+          name: Run container tests
+          command: |
+            export PATH=$GOROOT/bin:$PATH
+            go version
+            make container-tests
   integration-tests-container:
     machine:
       docker_layer_caching: true
@@ -119,50 +140,53 @@ jobs:
       KUBECTL_CHECKSUM: da9d557989a0b9671a610f21642052febb8f70c3cf144c98a8a4f7ecab6bafe2
     working_directory: /home/circleci/src/github.com/weaveworks/wksctl
     steps:
-      # - checkout
-      # - run:
-      #     name: Install go
-      #     command: |
-      #       (cd ~ && curl -L $GOURL -o go.tar.gz && echo "$GOCHECKSUM go.tar.gz" | sha256sum -c)
-      #       mkdir -p $GOROOT && tar xf ~/go.tar.gz -C $GOROOT --strip-components 1
-      # - run:
-      #     name: Install hugo
-      #     command: |
-      #       curl -L $HUGO_URL -o hugo.tar.gz
-      #       echo "$HUGO_CHECKSUM hugo.tar.gz" | sha256sum -c
-      #       tar xzf hugo.tar.gz hugo
-      #       chmod +x hugo
-      #       sudo mv hugo /usr/local/bin
-      # - run:
-      #     name: Install footloose
-      #     command: |
-      #       curl -L $FOOTLOOSE_URL -o footloose
-      #       echo "$FOOTLOOSE_CHECKSUM footloose" | sha256sum -c
-      #       chmod +x footloose
-      #       sudo mv footloose /usr/local/bin
-      # - run:
-      #     name: Install kubectl
-      #     command: |
-      #       curl -L $KUBECTL_URL -o kubectl.tar.gz
-      #       echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
-      #       tar xvzf kubectl.tar.gz --strip-components=3
-      #       sudo mv kubectl /usr/local/bin
-      # - restore_cache:
-      #     keys:
-      #       - local-docker-registry-images
-      # - run:
-      #     name: Run integration container tests
-      #     command: |
-      #       export PATH=$GOROOT/bin:$PATH
-      #       go version
-      #       make integration-tests-container
-      # - save_cache:
-      #     key: local-docker-registry-images
-      #     paths:
-      #       # This ought to match the path mounted by the local Docker registry
-      #       # in the integration tests.
-      #       - "/tmp/registry"
-      - run: "true"
+      - checkout
+      - run:
+          name: Install go
+          command: |
+            (cd ~ && curl -L $GOURL -o go.tar.gz && echo "$GOCHECKSUM go.tar.gz" | sha256sum -c)
+            mkdir -p $GOROOT && tar xf ~/go.tar.gz -C $GOROOT --strip-components 1
+      - run:
+          name: Install hugo
+          command: |
+            curl -L $HUGO_URL -o hugo.tar.gz
+            echo "$HUGO_CHECKSUM hugo.tar.gz" | sha256sum -c
+            tar xzf hugo.tar.gz hugo
+            chmod +x hugo
+            sudo mv hugo /usr/local/bin
+      - run:
+          name: Install footloose
+          command: |
+            curl -L $FOOTLOOSE_URL -o footloose
+            echo "$FOOTLOOSE_CHECKSUM footloose" | sha256sum -c
+            chmod +x footloose
+            sudo mv footloose /usr/local/bin
+      - run:
+          name: Install kubectl
+          command: |
+            curl -L $KUBECTL_URL -o kubectl.tar.gz
+            echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
+            tar xvzf kubectl.tar.gz --strip-components=3
+            sudo mv kubectl /usr/local/bin
+      - restore_cache:
+          keys:
+            - local-docker-registry-images
+      - run:
+          name: Run integration container tests
+          command: |
+            export PATH=$GOROOT/bin:$PATH
+            go version
+            make integration-tests-container
+      - save_cache:
+          key: local-docker-registry-images
+          paths:
+            # This ought to match the path mounted by the local Docker registry
+            # in the integration tests.
+            - "/tmp/registry"
+  #
+  # GCP tests are running under the `wks-tests` project for now.
+  # https://console.cloud.google.com/compute/instances?project=wks-tests
+  #
   integration-tests-gcp-centos:
     docker:
       - image: quay.io/wks/build:master-134af34f
@@ -171,39 +195,32 @@ jobs:
           SRCDIR: /src/github.com/weaveworks/wksctl
           KUBECTL_URL: https://dl.k8s.io/v1.10.5/kubernetes-client-linux-amd64.tar.gz
           KUBECTL_CHECKSUM: da9d557989a0b9671a610f21642052febb8f70c3cf144c98a8a4f7ecab6bafe2
-          CREATE_IMAGE: 0
-          USE_IMAGE: 0
+          CREATE_IMAGE: 1
+          USE_IMAGE: 1
           IMAGE_NAME: centos-cloud/centos-7
     working_directory: /src/github.com/weaveworks/wksctl
     steps:
-      # - checkout
-      # - setup_remote_docker
-
-      # - attach_workspace:
-      #     at: /tmp/workspace
-      # - run: /tmp/workspace/cmd/wksctl/wksctl version
-      # - run: env
-
-      # - run:
-      #     name: Install kubectl
-      #     command: |
-      #       curl -L $KUBECTL_URL -o kubectl.tar.gz
-      #       echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
-      #       tar xvzf kubectl.tar.gz --strip-components=3
-      #       sudo mv kubectl /usr/local/bin
-
-      # - run:
-      #     name: Create VMs
-      #     command: $SRCDIR/test/integration/bin/up.sh
-
-      # - run:
-      #     name: Run integration tests
-      #     command: $SRCDIR/test/integration/bin/test.sh
+      - checkout
+      - setup_remote_docker
 
-      # - run:
-      #     name: Destroy VMs
-      #     command: $SRCDIR/test/integration/bin/down.sh
-      #     when: always
+      - attach_workspace:
+          at: /tmp/workspace
+      - run: /tmp/workspace/cmd/wksctl/wksctl version
+      - run:
+          name: Install kubectl
+          command: |
+            curl -L $KUBECTL_URL -o kubectl.tar.gz
+            echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
+            tar xvzf kubectl.tar.gz --strip-components=3
+            sudo mv kubectl /usr/local/bin
+      - run:
+          name: Centos integration tests
+          command: |
+            if [ -n "$SECRET_KEY" ]; then
+              $SRCDIR/test/integration/bin/up.sh
+              $SRCDIR/test/integration/bin/test.sh
+              $SRCDIR/test/integration/bin/down.sh
+            fi
       - run: "true"
   integration-tests-gcp-ubuntu:
     docker:
@@ -218,32 +235,63 @@ jobs:
           IMAGE_NAME: ubuntu-os-cloud/ubuntu-1804-bionic-v20190530
     working_directory: /src/github.com/weaveworks/wksctl
     steps:
-      # - checkout
-      # - setup_remote_docker
+      - checkout
+      - setup_remote_docker
 
-      # - attach_workspace:
-      #     at: /tmp/workspace
-      # - run: /tmp/workspace/cmd/wksctl/wksctl version
-      # - run: env
+      - attach_workspace:
+          at: /tmp/workspace
+      - run: /tmp/workspace/cmd/wksctl/wksctl version
+      - run:
+          name: Install kubectl
+          command: |
+            curl -L $KUBECTL_URL -o kubectl.tar.gz
+            echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
+            tar xvzf kubectl.tar.gz --strip-components=3
+            sudo mv kubectl /usr/local/bin
 
-      # - run:
-      #     name: Install kubectl
-      #     command: |
-      #       curl -L $KUBECTL_URL -o kubectl.tar.gz
-      #       echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
-      #       tar xvzf kubectl.tar.gz --strip-components=3
-      #       sudo mv kubectl /usr/local/bin
+      - run:
+          name: Ubuntu integration tests
+          command: |
+            if [ -n "$SECRET_KEY" ]; then
+              $SRCDIR/test/integration/bin/up.sh
+              $SRCDIR/test/integration/bin/test.sh
+              $SRCDIR/test/integration/bin/down.sh
+            fi
+      - run: "true"
+  integration-tests-gcp-rhel:
+    docker:
+      - image: quay.io/wks/build:master-134af34f
+        environment:
+          GOPATH: /go/
+          SRCDIR: /src/github.com/weaveworks/wksctl
+          KUBECTL_URL: https://dl.k8s.io/v1.10.5/kubernetes-client-linux-amd64.tar.gz
+          KUBECTL_CHECKSUM: da9d557989a0b9671a610f21642052febb8f70c3cf144c98a8a4f7ecab6bafe2
+          CREATE_IMAGE: 1
+          USE_IMAGE: 1
+          IMAGE_NAME: rhel-cloud/rhel-7
+    working_directory: /src/github.com/weaveworks/wksctl
+    steps:
+      - checkout
+      - setup_remote_docker
 
-      # - run:
-      #     name: Create VMs
-      #     command: $SRCDIR/test/integration/bin/up.sh
+      - attach_workspace:
+          at: /tmp/workspace
+      - run: /tmp/workspace/cmd/wksctl/wksctl version
+      - run:
+          name: Install kubectl
+          command: |
+            curl -L $KUBECTL_URL -o kubectl.tar.gz
+            echo "$KUBECTL_CHECKSUM kubectl.tar.gz" | sha256sum -c
+            tar xvzf kubectl.tar.gz --strip-components=3
+            sudo mv kubectl /usr/local/bin
 
-      # - run:
-      #     name: Run integration tests
-      #     command: $SRCDIR/test/integration/bin/test.sh
+      - run:
+          name: rhel integration tests
+          command: |
+            if [ -n "$SECRET_KEY" ]; then
+              $SRCDIR/test/integration/bin/up.sh
+              $SRCDIR/test/integration/bin/test.sh
+              $SRCDIR/test/integration/bin/down.sh
+            fi
 
-      # - run:
-      #     name: Destroy VMs
-      #     command: $SRCDIR/test/integration/bin/down.sh
-      #     when: always
       - run: "true"

.github/workflows/check-links.yaml

@@ -0,0 +1,28 @@
+# https://github.com/marketplace/actions/link-checker
+on: [push, pull_request]
+name: Check links in docs
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements.txt
+      - name: Build docs for link check
+        run: mkdocs build
+      - name: Link Checker
+        id: lc
+        uses: peter-evans/link-checker@v1
+        with:
+          args: -r ./site *.md -x https://wksctl.readthedocs.io
+      - name: Fail if there were link errors
+        run: exit ${{ steps.lc.outputs.exit_code }}

.gitignore

@@ -1,4 +1,3 @@
-*_vfsdata.go
 .uptodate
 /examples/.vagrant
 /rpm/output
@@ -9,7 +8,6 @@
 /cmd/mock-authz-server/server
 /cmd/mock-https-authz-server/server
 /cmd/wksctl/wksctl
-*_vfsdata.go
 
 # Ignore files generated by footlose:
 cluster-key
@@ -29,3 +27,6 @@ terraform.tfstate
 terraform.tfstate.backup
 .terraform.tfstate.lock.info
 tf.json
+
+# Docs
+site