Compare commits
115 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c017a87c4c | |||
| f21e5bede0 | |||
| 4896617402 | |||
| 5b9ebfb2d8 | |||
| 628f9d3ef6 | |||
| 5a95211c2f | |||
| b926404924 | |||
| 53104347c2 | |||
| 123c331889 | |||
| 9ce383cf2c | |||
| 06bf1b863c | |||
| e656306216 | |||
| 82ed33b180 | |||
| e4a1fa89fa | |||
| 66e8afd9a4 | |||
| b1e18abf75 | |||
| 5a725fd5c6 | |||
| cda07939db | |||
|
|
7533ed95ad | ||
|
|
98bb4e4ba4 | ||
|
|
e07eb1399b | ||
|
|
9a9987eeb2 | ||
|
|
fed0a769f2 | ||
|
|
48473bd9d8 | ||
|
|
64045fadfb | ||
|
|
c5a7551da8 | ||
|
|
eeccfdd143 | ||
|
|
8d450bbf7d | ||
|
|
a566ea0cf7 | ||
|
|
24f10ce1b9 | ||
|
|
7c033a8b0a | ||
|
|
e482a144c1 | ||
|
|
8dba329407 | ||
|
|
4462307983 | ||
|
|
cfc59a46ef | ||
|
|
5b4e3ab2ea | ||
|
|
0e58dde591 | ||
|
|
1809d7b133 | ||
|
|
70b2a2d0b4 | ||
|
|
03b066bfd7 | ||
|
|
fe0c874815 | ||
|
|
91d4506b37 | ||
|
|
0ab0a7fee4 | ||
|
|
0b17d929a7 | ||
|
|
3fea592040 | ||
|
|
d7a9eccb13 | ||
|
|
9e3a424a36 | ||
|
|
774bbb74db | ||
|
|
e0157d9bc2 | ||
|
|
1f2da68bbb | ||
|
|
7e2f982af7 | ||
|
|
0502d76c63 | ||
|
|
591b084970 | ||
|
|
f24a8e44ca | ||
|
|
8cb8a5d95d | ||
|
|
a4834dd4f7 | ||
|
|
8b6a8fdd4b | ||
|
|
dbcef2699e | ||
|
|
22aa1df894 | ||
|
|
8f7b481934 | ||
|
|
e843b26759 | ||
|
|
713dcd8317 | ||
|
|
18313eeb5c | ||
|
|
ee6d8d1724 | ||
|
|
fcddc6e077 | ||
|
|
c4b11795e3 | ||
|
|
ffa636ce47 | ||
|
|
c38537ac32 | ||
|
|
1f7b6bb389 | ||
|
|
79532e7635 | ||
|
|
a21848484b | ||
|
|
d8ddb79ef4 | ||
|
|
231138563c | ||
|
|
88bb8085b0 | ||
|
|
21b9d32329 | ||
|
|
588c7cb9f7 | ||
|
|
16117eea2f | ||
|
|
8a9cf23ab9 | ||
|
|
3d1a2227da | ||
|
|
a826f66425 | ||
|
|
71421fbaa5 | ||
|
|
cfd8e33995 | ||
|
|
a5342d7bac | ||
|
|
6aa1d79d56 | ||
|
|
1d1117ba49 | ||
|
|
04de280821 | ||
|
|
7cfe20db1f | ||
|
|
7fc8212451 | ||
|
|
7cb7ecec90 | ||
|
|
55017eed0f | ||
|
|
b6ba856c31 | ||
|
|
8c6c6fbfa5 | ||
|
|
e071d23fef | ||
|
|
c8b4ad4c46 | ||
|
|
971e3f17cb | ||
|
|
ee3dc9ff0e | ||
|
|
7ecfe70e3e | ||
|
|
d5bd083bf5 | ||
|
|
8d8bcf78a7 | ||
|
|
222261d931 | ||
|
|
e694d93445 | ||
|
|
eaac6dd643 | ||
|
|
c569059b87 | ||
|
|
45428a2e25 | ||
|
|
7b816ea257 | ||
|
|
3c44be059e | ||
|
|
11ffdc7210 | ||
|
|
b4a13d9971 | ||
|
|
4330728215 | ||
|
|
3ae13d4b3c | ||
|
|
17724e7015 | ||
|
|
04a2c48ece | ||
|
|
997a33fc0d | ||
|
|
280c8577a4 | ||
|
|
51058470e5 |
52
.drone.yml
52
.drone.yml
@@ -1,32 +1,36 @@
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: default
|
||||
type: kubernetes
|
||||
name: build
|
||||
|
||||
trigger:
|
||||
branch:
|
||||
- master
|
||||
|
||||
clone:
|
||||
# disable: true
|
||||
depth: 1
|
||||
|
||||
image_pull_secrets:
|
||||
- dockerconfig
|
||||
|
||||
steps:
|
||||
- name: test
|
||||
image: golang:1.13
|
||||
commands:
|
||||
- go test ./cmd/... ./internal/...
|
||||
- go vet ./cmd/... ./internal/...
|
||||
- name: lint
|
||||
image: cytopia/golint
|
||||
commands:
|
||||
- golint -set_exit_status ./cmd/... ./internal/...
|
||||
- name: build
|
||||
image: golang:1.13
|
||||
commands:
|
||||
- go build -o build/drone-helm cmd/drone-helm/main.go
|
||||
- name: publish_linux_amd64
|
||||
image: plugins/docker
|
||||
image: harbor.1sept.ru/drone/drone-kaniko
|
||||
settings:
|
||||
auto_tag: true
|
||||
registry: harbor.1sept.ru
|
||||
repo: drone/drone-helm3
|
||||
cache: false
|
||||
tags:
|
||||
- git-${DRONE_COMMIT_SHA:0:7}
|
||||
- latest
|
||||
username:
|
||||
from_secret: docker_username
|
||||
from_secret: harbor-username
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo:
|
||||
from_secret: plugin_repo
|
||||
dockerfile: Dockerfile
|
||||
when:
|
||||
event: [ tag, push ]
|
||||
from_secret: harbor-password
|
||||
|
||||
---
|
||||
kind: signature
|
||||
hmac: ab275b41f1621072152d6e85b5f94289be8dda38debd2a177e0f666960491c6e
|
||||
|
||||
...
|
||||
|
||||
3
.github/ISSUE_TEMPLATE/bug_report.md
vendored
3
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -7,6 +7,9 @@ assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**My drone-helm3 and drone versions:**
|
||||
<!-- e.g. drone-helm3 0.9.0, drone 1.6.0-->
|
||||
|
||||
**What I tried to do:**
|
||||
<!-- e.g. run a helm installation -->
|
||||
|
||||
|
||||
11
.github/ISSUE_TEMPLATE/documentation.md
vendored
Normal file
11
.github/ISSUE_TEMPLATE/documentation.md
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
name: Documentation
|
||||
about: Docs you'd like to see, or questions about existing docs
|
||||
title: ''
|
||||
labels: documentation
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**What needs explanation:**
|
||||
<!-- e.g. "what happens when ____", "how do I ___", etc. -->
|
||||
6
.github/pull_request_template.md
vendored
6
.github/pull_request_template.md
vendored
@@ -3,6 +3,8 @@
|
||||
Pre-merge checklist:
|
||||
|
||||
* [ ] Code changes have tests
|
||||
* [ ] Any changes to the config are documented in `docs/parameter_reference.md`
|
||||
* [ ] Any new _required_ config is documented in `README.md`
|
||||
* [ ] Any config changes are documented:
|
||||
* If the change touches _required_ config, there's a corresponding update to `README.md`
|
||||
* There's a corresponding update to `docs/parameter_reference.md`
|
||||
* There's a pull request to update [the parameter reference in drone-plugin-index](https://github.com/drone/drone-plugin-index/blob/master/content/pelotech/drone-helm3/index.md)
|
||||
* [ ] Any large changes have been verified by running a Drone job
|
||||
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -4,6 +4,7 @@
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
*.swp
|
||||
|
||||
.idea
|
||||
|
||||
@@ -17,3 +18,6 @@
|
||||
# vendor/
|
||||
.env
|
||||
.secrets
|
||||
|
||||
build/*
|
||||
**/.DS_Store
|
||||
|
||||
21
Dockerfile
21
Dockerfile
@@ -1,10 +1,19 @@
|
||||
FROM alpine/helm:3.0.2
|
||||
MAINTAINER Erin Call <erin@liffft.com>
|
||||
FROM golang:1.24-alpine3.21 AS builder
|
||||
|
||||
COPY build/drone-helm /bin/drone-helm
|
||||
COPY assets/kubeconfig.tpl /root/.kube/config.tpl
|
||||
ENV GO111MODULE=on
|
||||
WORKDIR /app
|
||||
|
||||
LABEL description="Helm 3 plugin for Drone 3"
|
||||
LABEL base="alpine/helm"
|
||||
COPY --link go.mod .
|
||||
COPY --link go.sum .
|
||||
RUN go mod download
|
||||
COPY --link . .
|
||||
|
||||
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o /go/bin/drone-helm ./cmd/drone-helm
|
||||
|
||||
# --- Copy the cli to an image with helm already installed ---
|
||||
FROM alpine/helm:3.18.5
|
||||
|
||||
COPY --link --from=builder /go/bin/drone-helm /bin/drone-helm
|
||||
COPY --link ./assets/kubeconfig.tpl /root/.kube/config.tpl
|
||||
|
||||
ENTRYPOINT [ "/bin/drone-helm" ]
|
||||
9
Makefile
Normal file
9
Makefile
Normal file
@@ -0,0 +1,9 @@
|
||||
help:
|
||||
@echo "make check - Check Dockerfile syntax"
|
||||
@echo "make drone-sign - Sign Drone config file"
|
||||
|
||||
check:
|
||||
docker build --check .
|
||||
|
||||
drone-sign: ## Envs DRONE_SERVER & DRONE_TOKEN needed
|
||||
drone sign --save 1sept/drone-helm3
|
||||
28
README.md
28
README.md
@@ -10,7 +10,7 @@ This plugin provides an interface between [Drone](https://drone.io/) and [Helm 3
|
||||
* Deploy your service
|
||||
* Delete your service
|
||||
|
||||
The plugin is inpsired by [drone-helm](https://github.com/ipedrazas/drone-helm), which fills the same role for Helm 2. It provides a comparable feature-set and the configuration settings are backwards-compatible.
|
||||
The plugin is inpsired by [drone-helm](https://github.com/ipedrazas/drone-helm), which fills the same role for Helm 2. It provides a comparable feature-set and the configuration settings are backward-compatible.
|
||||
|
||||
## Example configuration
|
||||
|
||||
@@ -23,7 +23,7 @@ steps:
|
||||
- name: lint
|
||||
image: pelotech/drone-helm3
|
||||
settings:
|
||||
helm_command: lint
|
||||
mode: lint
|
||||
chart: ./
|
||||
```
|
||||
|
||||
@@ -34,12 +34,12 @@ steps:
|
||||
- name: deploy
|
||||
image: pelotech/drone-helm3
|
||||
settings:
|
||||
helm_command: upgrade
|
||||
mode: upgrade
|
||||
chart: ./
|
||||
release: my-project
|
||||
environment:
|
||||
API_SERVER: https://my.kubernetes.installation/clusters/a-1234
|
||||
KUBERNETES_TOKEN:
|
||||
KUBE_API_SERVER: https://my.kubernetes.installation/clusters/a-1234
|
||||
KUBE_TOKEN:
|
||||
from_secret: kubernetes_token
|
||||
```
|
||||
|
||||
@@ -50,21 +50,22 @@ steps:
|
||||
- name: uninstall
|
||||
image: pelotech/drone-helm3
|
||||
settings:
|
||||
helm_command: uninstall
|
||||
mode: uninstall
|
||||
release: my-project
|
||||
environment:
|
||||
API_SERVER: https://my.kubernetes.installation/clusters/a-1234
|
||||
KUBERNETES_TOKEN:
|
||||
KUBE_API_SERVER: https://my.kubernetes.installation/clusters/a-1234
|
||||
KUBE_TOKEN:
|
||||
from_secret: kubernetes_token
|
||||
```
|
||||
|
||||
## Upgrading from drone-helm
|
||||
|
||||
drone-helm3 is largely backwards-compatible with drone-helm. There are some known differences:
|
||||
drone-helm3 is largely backward-compatible with drone-helm. There are some known differences:
|
||||
|
||||
* You'll need to migrate the deployments in the cluster [helm-v2-to-helm-v3](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/).
|
||||
* EKS is not supported. See [#5](https://github.com/pelotech/drone-helm3/issues/5) for more information.
|
||||
* The `prefix` setting is no longer supported. If you were relying on the `prefix` setting with `secrets: [...]`, you'll need to switch to the `from_secret` syntax.
|
||||
* During uninstallations, the release history is purged by default. Use `keep_history: true` to return to the old behavior.
|
||||
* Several settings no longer have any effect. The plugin will produce warnings if any of these are present:
|
||||
* `purge` -- this is the default behavior in Helm 3
|
||||
* `recreate_pods`
|
||||
@@ -73,6 +74,15 @@ drone-helm3 is largely backwards-compatible with drone-helm. There are some know
|
||||
* `canary_image`
|
||||
* `client_only`
|
||||
* `stable_repo_url`
|
||||
* Several settings have been renamed, to clarify their purpose and provide a more consistent naming scheme. For backward-compatibility, the old names are still available as aliases. If the old and new names are both present, the updated form takes priority. Conflicting settings will make your `.drone.yml` harder to understand, so we recommend updating to the new names:
|
||||
* `helm_command` is now `mode`
|
||||
° `helm_repos` is now `add_repos`
|
||||
* `api_server` is now `kube_api_server`
|
||||
* `service_account` is now `kube_service_account`
|
||||
* `kubernetes_token` is now `kube_token`
|
||||
* `kubernetes_certificate` is now `kube_certificate`
|
||||
* `wait` is now `wait_for_upgrade`
|
||||
* `force` is now `force_upgrade`
|
||||
|
||||
Since helm 3 does not require Tiller, we also recommend switching to a service account with less-expansive permissions.
|
||||
|
||||
|
||||
@@ -4,11 +4,13 @@ import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
_ "github.com/joho/godotenv/autoload"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/pelotech/drone-helm3/internal/helm"
|
||||
)
|
||||
|
||||
func main() {
|
||||
cfg, err := helm.NewConfig(os.Stdout, os.Stderr)
|
||||
cfg, err := env.NewConfig(os.Stdout, os.Stderr)
|
||||
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "%s\n", err.Error())
|
||||
|
||||
@@ -1,17 +1,19 @@
|
||||
# Parameter reference
|
||||
|
||||
## Global
|
||||
| Param name | Type | Purpose |
|
||||
|---------------------|-----------------|---------|
|
||||
| helm_command | string | Indicates the operation to perform. Recommended, but not required. Valid options are `upgrade`, `uninstall`, `lint`, and `help`. |
|
||||
| update_dependencies | boolean | Calls `helm dependency update` before running the main command.|
|
||||
| helm_repos | list\<string\> | Calls `helm repo add $repo` before running the main command. Each string should be formatted as `repo_name=https://repo.url/`. |
|
||||
| namespace | string | Kubernetes namespace to use for this operation. |
|
||||
| debug | boolean | Generate debug output within drone-helm3 and pass `--debug` to all helm commands. Use with care, since the debug output may include secrets. |
|
||||
| Param name | Type | Alias | Purpose |
|
||||
|---------------------|-----------------|--------------|---------|
|
||||
| mode | string | helm_command | Indicates the operation to perform. Recommended, but not required. Valid options are `upgrade`, `uninstall`, `lint`, and `help`. |
|
||||
| update_dependencies | boolean | | Calls `helm dependency update` before running the main command.|
|
||||
| add_repos | list\<string\> | helm_repos | Calls `helm repo add $repo` before running the main command. Each string should be formatted as `repo_name=https://repo.url/`. |
|
||||
| repo_certificate | string | | Base64 encoded TLS certificate for a chart repository. |
|
||||
| repo_ca_certificate | string | | Base64 encoded TLS certificate for a chart repository certificate authority. |
|
||||
| namespace | string | | Kubernetes namespace to use for this operation. |
|
||||
| debug | boolean | | Generate debug output within drone-helm3 and pass `--debug` to all helm commands. Use with care, since the debug output may include secrets. |
|
||||
|
||||
## Linting
|
||||
|
||||
Linting is only triggered when the `helm_command` setting is "lint".
|
||||
Linting is only triggered when the `mode` setting is "lint".
|
||||
|
||||
| Param name | Type | Required | Purpose |
|
||||
|---------------|----------------|----------|---------|
|
||||
@@ -19,49 +21,61 @@ Linting is only triggered when the `helm_command` setting is "lint".
|
||||
| values | list\<string\> | | Chart values to use as the `--set` argument to `helm lint`. |
|
||||
| string_values | list\<string\> | | Chart values to use as the `--set-string` argument to `helm lint`. |
|
||||
| values_files | list\<string\> | | Values to use as `--values` arguments to `helm lint`. |
|
||||
| lint_strictly | boolean | | Pass `--strict` to `helm lint`, to turn warnings into errors. |
|
||||
|
||||
## Installation
|
||||
|
||||
Installations are triggered when the `helm_command` setting is "upgrade." They can also be triggered when the build was triggered by a `push`, `tag`, `deployment`, `pull_request`, `promote`, or `rollback` Drone event.
|
||||
Installations are triggered when the `mode` setting is "upgrade." They can also be triggered when the build was triggered by a `push`, `tag`, `deployment`, `pull_request`, `promote`, or `rollback` Drone event.
|
||||
|
||||
| Param name | Type | Required | Purpose |
|
||||
|------------------------|----------------|----------|---------|
|
||||
| chart | string | yes | The chart to use for this installation. |
|
||||
| release | string | yes | The release name for helm to use. |
|
||||
| api_server | string | yes | API endpoint for the Kubernetes cluster. |
|
||||
| kubernetes_token | string | yes | Token for authenticating to Kubernetes. |
|
||||
| service_account | string | | Service account for authenticating to Kubernetes. Default is `helm`. |
|
||||
| kubernetes_certificate | string | | Base64 encoded TLS certificate used by the Kubernetes cluster's certificate authority. |
|
||||
| chart_version | string | | Specific chart version to install. |
|
||||
| dry_run | boolean | | Pass `--dry-run` to `helm upgrade`. |
|
||||
| wait | boolean | | Wait until kubernetes resources are in a ready state before marking the installation successful. |
|
||||
| timeout | duration | | Timeout for any *individual* Kubernetes operation. The installation's full runtime may exceed this duration. |
|
||||
| force | boolean | | Pass `--force` to `helm upgrade`. |
|
||||
| values | list\<string\> | | Chart values to use as the `--set` argument to `helm upgrade`. |
|
||||
| string_values | list\<string\> | | Chart values to use as the `--set-string` argument to `helm upgrade`. |
|
||||
| values_files | list\<string\> | | Values to use as `--values` arguments to `helm upgrade`. |
|
||||
| reuse_values | boolean | | Reuse the values from a previous release. |
|
||||
| skip_tls_verify | boolean | | Connect to the Kubernetes cluster without checking for a valid TLS certificate. Not recommended in production. |
|
||||
| Param name | Type | Required | Alias | Purpose |
|
||||
|------------------------|----------------|----------|------------------------|---------|
|
||||
| chart | string | yes | | The chart to use for this installation. |
|
||||
| release | string | yes | | The release name for helm to use. |
|
||||
| skip_kubeconfig | boolean | | | Whether to skip kubeconfig file creation. |
|
||||
| kube_api_server | string | yes | api_server | API endpoint for the Kubernetes cluster. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| kube_token | string | yes | kubernetes_token | Token for authenticating to Kubernetes. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| kube_service_account | string | | service_account | Service account for authenticating to Kubernetes. Default is `helm`. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| kube_certificate | string | | kubernetes_certificate | Base64 encoded TLS certificate used by the Kubernetes cluster's certificate authority. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| chart_version | string | | | Specific chart version to install. |
|
||||
| dry_run | boolean | | | Pass `--dry-run` to `helm upgrade`. |
|
||||
| dependencies_action | string | | | Calls `helm dependency build` OR `helm dependency update` before running the main command. Possible values: `build`, `update`. |
|
||||
| wait_for_upgrade | boolean | | wait | Wait until kubernetes resources are in a ready state before marking the installation successful. |
|
||||
| timeout | duration | | | Timeout for any *individual* Kubernetes operation. The installation's full runtime may exceed this duration. |
|
||||
| force_upgrade | boolean | | force | Pass `--force` to `helm upgrade`. |
|
||||
| atomic_upgrade | boolean | | | Pass `--atomic` to `helm upgrade`. |
|
||||
| cleanup_failed_upgrade | boolean | | | Pass `--cleanup-on-fail` to `helm upgrade`. |
|
||||
| history_max | int | | | Pass `--history-max` to `helm upgrade`. |
|
||||
| values | list\<string\> | | | Chart values to use as the `--set` argument to `helm upgrade`. |
|
||||
| string_values | list\<string\> | | | Chart values to use as the `--set-string` argument to `helm upgrade`. |
|
||||
| values_files | list\<string\> | | | Values to use as `--values` arguments to `helm upgrade`. |
|
||||
| reuse_values | boolean | | | Reuse the values from a previous release. |
|
||||
| skip_tls_verify | boolean | | | Connect to the Kubernetes cluster without checking for a valid TLS certificate. Not recommended in production. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| create_namespace | boolean | | | Pass --create-namespace to `helm upgrade`. |
|
||||
| skip_crds | boolean | | | Pass --skip-crds to `helm upgrade`. |
|
||||
|
||||
## Uninstallation
|
||||
|
||||
Uninstallations are triggered when the `helm_command` setting is "uninstall" or "delete." They can also be triggered when the build was triggered by a `delete` Drone event.
|
||||
Uninstallations are triggered when the `mode` setting is "uninstall" or "delete." They can also be triggered when the build was triggered by a `delete` Drone event.
|
||||
|
||||
| Param name | Type | Required | Purpose |
|
||||
|------------------------|----------|----------|---------|
|
||||
| release | string | yes | The release name for helm to use. |
|
||||
| api_server | string | yes | API endpoint for the Kubernetes cluster. |
|
||||
| kubernetes_token | string | yes | Token for authenticating to Kubernetes. |
|
||||
| service_account | string | | Service account for authenticating to Kubernetes. Default is `helm`. |
|
||||
| kubernetes_certificate | string | | Base64 encoded TLS certificate used by the Kubernetes cluster's certificate authority. |
|
||||
| dry_run | boolean | | Pass `--dry-run` to `helm uninstall`. |
|
||||
| timeout | duration | | Timeout for any *individual* Kubernetes operation. The uninstallation's full runtime may exceed this duration. |
|
||||
| skip_tls_verify | boolean | | Connect to the Kubernetes cluster without checking for a valid TLS certificate. Not recommended in production. |
|
||||
| chart | string | | Required when the global `update_dependencies` parameter is true. No effect otherwise. |
|
||||
| Param name | Type | Required | Alias | Purpose |
|
||||
|------------------------|----------|----------|------------------------|---------|
|
||||
| release | string | yes | | The release name for helm to use. |
|
||||
| skip_kubeconfig | boolean | | | Whether to skip kubeconfig file creation. |
|
||||
| kube_api_server | string | yes | api_server | API endpoint for the Kubernetes cluster. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| kube_token | string | yes | kubernetes_token | Token for authenticating to Kubernetes. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| kube_service_account | string | | service_account | Service account for authenticating to Kubernetes. Default is `helm`. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| kube_certificate | string | | kubernetes_certificate | Base64 encoded TLS certificate used by the Kubernetes cluster's certificate authority. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| keep_history | boolean | | | Pass `--keep-history` to `helm uninstall`, to retain the release history. |
|
||||
| dry_run | boolean | | | Pass `--dry-run` to `helm uninstall`. |
|
||||
| timeout | duration | | | Timeout for any *individual* Kubernetes operation. The uninstallation's full runtime may exceed this duration. |
|
||||
| skip_tls_verify | boolean | | | Connect to the Kubernetes cluster without checking for a valid TLS certificate. Not recommended in production. This is ignored if `skip_kubeconfig` is `true`. |
|
||||
| chart | string | | | Required when the global `update_dependencies` parameter is true. No effect otherwise. |
|
||||
|
||||
### Where to put settings
|
||||
|
||||
Any setting can go in either the `settings` or `environment` section.
|
||||
Any setting can go in either the `settings` or `environment` section. If a setting exists in _both_ sections, the version in `environment` will override the version in `settings`.
|
||||
|
||||
We recommend putting all drone-helm3 configuration in the `settings` block and limiting the `environment` block to variables that are used when building your charts.
|
||||
|
||||
### Formatting non-string values
|
||||
|
||||
@@ -86,3 +100,38 @@ Note that **list members must not contain commas**. Both of the following are eq
|
||||
values_files: [ "./over_9,000.yml" ]
|
||||
values_files: [ "./over_9", "000.yml" ]
|
||||
```
|
||||
|
||||
### Interpolating secrets into the `values`, `string_values` and `add_repos` settings
|
||||
|
||||
If you want to send secrets to your charts, you can use syntax similar to shell variable interpolation--either `$VARNAME` or `$${VARNAME}`. The double dollar-sign is necessary when using curly brackets; using curly brackets with a single dollar-sign will trigger Drone's string substitution (which can't use arbitrary environment variables). If an environment variable is not set, it will be treated as if it were set to the empty string.
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
DB_PASSWORD:
|
||||
from_secret: db_password
|
||||
SESSION_KEY:
|
||||
from_secret: session_key
|
||||
settings:
|
||||
values:
|
||||
- db_password=$DB_PASSWORD # db_password will be set to the contents of the db_password secret
|
||||
- db_pass=$DB_PASS # db_pass will be set to "" since $DB_PASS is not set
|
||||
- session_key=$${SESSION_KEY} # session_key will be set to the contents of the session_key secret
|
||||
- sess_key=${SESSION_KEY} # sess_key will be set to "" by Drone's variable substitution
|
||||
```
|
||||
|
||||
Variables intended for interpolation must be set in the `environment` section, not `settings`.
|
||||
|
||||
### Backward-compatibility aliases
|
||||
|
||||
Some settings have alternate names, for backward-compatibility with drone-helm. We recommend using the canonical name unless you require the backward-compatible form.
|
||||
|
||||
| Canonical name | Alias |
|
||||
|----------------------|-------|
|
||||
| mode | helm_command |
|
||||
| add_repos | helm_repos |
|
||||
| kube_api_server | api_server |
|
||||
| kube_service_account | service_account |
|
||||
| kube_token | kubernetes_token |
|
||||
| kube_certificate | kubernetes_certificate |
|
||||
| wait_for_upgrade | wait |
|
||||
| force_upgrade | force |
|
||||
|
||||
1
go.mod
1
go.mod
@@ -4,6 +4,7 @@ go 1.13
|
||||
|
||||
require (
|
||||
github.com/golang/mock v1.3.1
|
||||
github.com/joho/godotenv v1.3.0
|
||||
github.com/kelseyhightower/envconfig v1.4.0
|
||||
github.com/stretchr/testify v1.4.0
|
||||
golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f // indirect
|
||||
|
||||
2
go.sum
2
go.sum
@@ -2,6 +2,8 @@ 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/golang/mock v1.3.1 h1:qGJ6qTW+x6xX/my+8YUVl4WNpX9B7+/l2tRsHGZ7f2s=
|
||||
github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y=
|
||||
github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
|
||||
github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
|
||||
github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8=
|
||||
github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
|
||||
177
internal/env/config.go
vendored
Normal file
177
internal/env/config.go
vendored
Normal file
@@ -0,0 +1,177 @@
|
||||
package env
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/kelseyhightower/envconfig"
|
||||
)
|
||||
|
||||
const (
|
||||
defaultHistoryMax = 10
|
||||
)
|
||||
|
||||
var (
|
||||
justNumbers = regexp.MustCompile(`^\d+$`)
|
||||
deprecatedVars = []string{"PURGE", "RECREATE_PODS", "TILLER_NS", "UPGRADE", "CANARY_IMAGE", "CLIENT_ONLY", "STABLE_REPO_URL"}
|
||||
)
|
||||
|
||||
// The Config struct captures the `settings` and `environment` blocks in the application's drone
|
||||
// config. Configuration in drone's `settings` block arrives as uppercase env vars matching the
|
||||
// config key, prefixed with `PLUGIN_`. Config from the `environment` block is uppercased, but does
|
||||
// not have the `PLUGIN_` prefix.
|
||||
type Config struct {
|
||||
// Configuration for drone-helm itself
|
||||
Command string `envconfig:"mode"` // Helm command to run
|
||||
DroneEvent string `envconfig:"drone_build_event"` // Drone event that invoked this plugin.
|
||||
UpdateDependencies bool `split_words:"true"` // [Deprecated] Call `helm dependency update` before the main command (deprecated, use dependencies_action: update instead)
|
||||
DependenciesAction string `split_words:"true"` // Call `helm dependency build` or `helm dependency update` before the main command
|
||||
AddRepos []string `split_words:"true"` // Call `helm repo add` before the main command
|
||||
RepoCertificate string `envconfig:"repo_certificate"` // The Helm chart repository's self-signed certificate (must be base64-encoded)
|
||||
RepoCACertificate string `envconfig:"repo_ca_certificate"` // The Helm chart repository CA's self-signed certificate (must be base64-encoded)
|
||||
Debug bool `` // Generate debug output and pass --debug to all helm commands
|
||||
Values string `` // Argument to pass to --set in applicable helm commands
|
||||
StringValues string `split_words:"true"` // Argument to pass to --set-string in applicable helm commands
|
||||
ValuesFiles []string `split_words:"true"` // Arguments to pass to --values in applicable helm commands
|
||||
Namespace string `` // Kubernetes namespace for all helm commands
|
||||
CreateNamespace bool `split_words:"true"` // Pass --create-namespace to `helm upgrade`
|
||||
KubeToken string `split_words:"true"` // Kubernetes authentication token to put in .kube/config
|
||||
SkipKubeconfig bool `envconfig:"skip_kubeconfig"` // Skip kubeconfig creation
|
||||
SkipTLSVerify bool `envconfig:"skip_tls_verify"` // Put insecure-skip-tls-verify in .kube/config
|
||||
Certificate string `envconfig:"kube_certificate"` // The Kubernetes cluster CA's self-signed certificate (must be base64-encoded)
|
||||
APIServer string `envconfig:"kube_api_server"` // The Kubernetes cluster's API endpoint
|
||||
ServiceAccount string `envconfig:"kube_service_account"` // Account to use for connecting to the Kubernetes cluster
|
||||
ChartVersion string `split_words:"true"` // Specific chart version to use in `helm upgrade`
|
||||
DryRun bool `split_words:"true"` // Pass --dry-run to applicable helm commands
|
||||
Wait bool `envconfig:"wait_for_upgrade"` // Pass --wait to applicable helm commands
|
||||
ReuseValues bool `split_words:"true"` // Pass --reuse-values to `helm upgrade`
|
||||
KeepHistory bool `split_words:"true"` // Pass --keep-history to `helm uninstall`
|
||||
HistoryMax int `split_words:"true"` // Pass --history-max option
|
||||
Timeout string `` // Argument to pass to --timeout in applicable helm commands
|
||||
Chart string `` // Chart argument to use in applicable helm commands
|
||||
Release string `` // Release argument to use in applicable helm commands
|
||||
Force bool `envconfig:"force_upgrade"` // Pass --force to applicable helm commands
|
||||
AtomicUpgrade bool `split_words:"true"` // Pass --atomic to `helm upgrade`
|
||||
CleanupOnFail bool `envconfig:"cleanup_failed_upgrade"` // Pass --cleanup-on-fail to `helm upgrade`
|
||||
LintStrictly bool `split_words:"true"` // Pass --strict to `helm lint`
|
||||
SkipCrds bool `split_words:"true"` // Pass --skip-crds to `helm upgrade`
|
||||
|
||||
Stdout io.Writer `ignored:"true"`
|
||||
Stderr io.Writer `ignored:"true"`
|
||||
}
|
||||
|
||||
// NewConfig creates a Config and reads environment variables into it, accounting for several possible formats.
|
||||
func NewConfig(stdout, stderr io.Writer) (*Config, error) {
|
||||
var aliases settingAliases
|
||||
if err := envconfig.Process("plugin", &aliases); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := envconfig.Process("", &aliases); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
cfg := Config{
|
||||
Command: aliases.Command,
|
||||
AddRepos: aliases.AddRepos,
|
||||
APIServer: aliases.APIServer,
|
||||
ServiceAccount: aliases.ServiceAccount,
|
||||
Wait: aliases.Wait,
|
||||
Force: aliases.Force,
|
||||
KubeToken: aliases.KubeToken,
|
||||
Certificate: aliases.Certificate,
|
||||
|
||||
// set to same default as helm CLI
|
||||
HistoryMax: defaultHistoryMax,
|
||||
|
||||
Stdout: stdout,
|
||||
Stderr: stderr,
|
||||
}
|
||||
if err := envconfig.Process("plugin", &cfg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := envconfig.Process("", &cfg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if cfg.SkipKubeconfig {
|
||||
if cfg.KubeToken != "" || cfg.Certificate != "" || cfg.APIServer != "" || cfg.ServiceAccount != "" || cfg.SkipTLSVerify {
|
||||
fmt.Fprintf(cfg.Stderr, "Warning: skip_kubeconfig is set. The following kubeconfig-related settings will be ignored: kube_config, kube_certificate, kube_api_server, kube_service_account, skip_tls_verify.")
|
||||
}
|
||||
}
|
||||
|
||||
if justNumbers.MatchString(cfg.Timeout) {
|
||||
cfg.Timeout = fmt.Sprintf("%ss", cfg.Timeout)
|
||||
}
|
||||
|
||||
cfg.loadValuesSecrets()
|
||||
|
||||
if cfg.Debug && cfg.Stderr != nil {
|
||||
cfg.logDebug()
|
||||
}
|
||||
|
||||
cfg.deprecationWarn()
|
||||
|
||||
return &cfg, nil
|
||||
}
|
||||
|
||||
func (cfg *Config) loadValuesSecrets() {
|
||||
findVar := regexp.MustCompile(`\$\{?(\w+)\}?`)
|
||||
|
||||
replacer := func(varName string) string {
|
||||
sigils := regexp.MustCompile(`[${}]`)
|
||||
varName = sigils.ReplaceAllString(varName, "")
|
||||
|
||||
if value, ok := os.LookupEnv(varName); ok {
|
||||
return value
|
||||
}
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "$%s not present in environment, replaced with \"\"\n", varName)
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
cfg.Values = findVar.ReplaceAllStringFunc(cfg.Values, replacer)
|
||||
cfg.StringValues = findVar.ReplaceAllStringFunc(cfg.StringValues, replacer)
|
||||
|
||||
for i := 0; i < len(cfg.AddRepos); i++ {
|
||||
cfg.AddRepos[i] = findVar.ReplaceAllStringFunc(cfg.AddRepos[i], replacer)
|
||||
}
|
||||
}
|
||||
|
||||
func (cfg Config) logDebug() {
|
||||
if cfg.KubeToken != "" {
|
||||
cfg.KubeToken = "(redacted)"
|
||||
}
|
||||
fmt.Fprintf(cfg.Stderr, "Generated config: %+v\n", cfg)
|
||||
}
|
||||
|
||||
func (cfg *Config) deprecationWarn() {
|
||||
for _, varname := range deprecatedVars {
|
||||
_, barePresent := os.LookupEnv(varname)
|
||||
_, prefixedPresent := os.LookupEnv("PLUGIN_" + varname)
|
||||
if barePresent || prefixedPresent {
|
||||
fmt.Fprintf(cfg.Stderr, "Warning: ignoring deprecated '%s' setting\n", strings.ToLower(varname))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// settingAliases provides alternate environment variable names for certain settings, either because
|
||||
// they were renamed during drone-helm3's lifetime or for backward-compatibility with the original
|
||||
// drone-helm. Most config options don't need to be included here; adding them to the main Config
|
||||
// struct is sufficient.
|
||||
type settingAliases struct {
|
||||
Command string `envconfig:"helm_command"`
|
||||
AddRepos []string `envconfig:"helm_repos"`
|
||||
APIServer string `envconfig:"api_server"`
|
||||
ServiceAccount string `split_words:"true"`
|
||||
Wait bool ``
|
||||
Force bool ``
|
||||
KubeToken string `envconfig:"kubernetes_token"`
|
||||
Certificate string `envconfig:"kubernetes_certificate"`
|
||||
}
|
||||
261
internal/env/config_test.go
vendored
Normal file
261
internal/env/config_test.go
vendored
Normal file
@@ -0,0 +1,261 @@
|
||||
package env
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/suite"
|
||||
)
|
||||
|
||||
type ConfigTestSuite struct {
|
||||
suite.Suite
|
||||
// These tests need to mutate the environment, so the suite.setenv and .unsetenv functions store the original contents of the
|
||||
// relevant variable in this map. Its use of *string is so they can distinguish between "not set" and "set to empty string"
|
||||
envBackup map[string]*string
|
||||
}
|
||||
|
||||
func TestConfigTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(ConfigTestSuite))
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithPluginPrefix() {
|
||||
suite.unsetenv("MODE")
|
||||
suite.unsetenv("UPDATE_DEPENDENCIES")
|
||||
suite.unsetenv("DEBUG")
|
||||
|
||||
suite.setenv("PLUGIN_MODE", "iambic")
|
||||
suite.setenv("PLUGIN_UPDATE_DEPENDENCIES", "true")
|
||||
suite.setenv("PLUGIN_DEBUG", "true")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("iambic", cfg.Command)
|
||||
suite.True(cfg.UpdateDependencies)
|
||||
suite.True(cfg.Debug)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithNoPrefix() {
|
||||
suite.unsetenv("PLUGIN_MODE")
|
||||
suite.unsetenv("PLUGIN_UPDATE_DEPENDENCIES")
|
||||
suite.unsetenv("PLUGIN_DEBUG")
|
||||
|
||||
suite.setenv("MODE", "iambic")
|
||||
suite.setenv("UPDATE_DEPENDENCIES", "true")
|
||||
suite.setenv("DEBUG", "true")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("iambic", cfg.Command)
|
||||
suite.True(cfg.UpdateDependencies)
|
||||
suite.True(cfg.Debug)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithConflictingVariables() {
|
||||
suite.setenv("PLUGIN_MODE", "iambic")
|
||||
suite.setenv("MODE", "haiku") // values from the `environment` block override those from `settings`
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("haiku", cfg.Command)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigInfersNumbersAreSeconds() {
|
||||
suite.setenv("PLUGIN_TIMEOUT", "42")
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("42s", cfg.Timeout)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithAliases() {
|
||||
for _, varname := range []string{
|
||||
"MODE",
|
||||
"ADD_REPOS",
|
||||
"KUBE_API_SERVER",
|
||||
"KUBE_SERVICE_ACCOUNT",
|
||||
"WAIT_FOR_UPGRADE",
|
||||
"FORCE_UPGRADE",
|
||||
"KUBE_TOKEN",
|
||||
"KUBE_CERTIFICATE",
|
||||
} {
|
||||
suite.unsetenv(varname)
|
||||
suite.unsetenv("PLUGIN_" + varname)
|
||||
}
|
||||
suite.setenv("PLUGIN_HELM_COMMAND", "beware the jabberwock")
|
||||
suite.setenv("PLUGIN_HELM_REPOS", "chortle=http://calloo.callay/frabjous/day")
|
||||
suite.setenv("PLUGIN_API_SERVER", "http://tumtum.tree")
|
||||
suite.setenv("PLUGIN_SERVICE_ACCOUNT", "tulgey")
|
||||
suite.setenv("PLUGIN_WAIT", "true")
|
||||
suite.setenv("PLUGIN_FORCE", "true")
|
||||
suite.setenv("PLUGIN_KUBERNETES_TOKEN", "Y29tZSB0byBteSBhcm1z")
|
||||
suite.setenv("PLUGIN_KUBERNETES_CERTIFICATE", "d2l0aCBpdHMgaGVhZA==")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("beware the jabberwock", cfg.Command)
|
||||
suite.Equal([]string{"chortle=http://calloo.callay/frabjous/day"}, cfg.AddRepos)
|
||||
suite.Equal("http://tumtum.tree", cfg.APIServer)
|
||||
suite.Equal("tulgey", cfg.ServiceAccount)
|
||||
suite.True(cfg.Wait, "Wait should be aliased")
|
||||
suite.True(cfg.Force, "Force should be aliased")
|
||||
suite.Equal("Y29tZSB0byBteSBhcm1z", cfg.KubeToken, "KubeToken should be aliased")
|
||||
suite.Equal("d2l0aCBpdHMgaGVhZA==", cfg.Certificate, "Certificate should be aliased")
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestAliasedSettingWithoutPluginPrefix() {
|
||||
suite.unsetenv("FORCE_UPGRADE")
|
||||
suite.unsetenv("PLUGIN_FORCE_UPGRADE")
|
||||
suite.unsetenv("PLUGIN_FORCE")
|
||||
suite.setenv("FORCE", "true")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
suite.True(cfg.Force)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithAliasConflicts() {
|
||||
suite.unsetenv("FORCE_UPGRADE")
|
||||
suite.setenv("PLUGIN_FORCE", "true")
|
||||
suite.setenv("PLUGIN_FORCE_UPGRADE", "false") // should override even when set to the zero value
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.NoError(err)
|
||||
suite.False(cfg.Force, "official names should override alias names")
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigSetsWriters() {
|
||||
stdout := &strings.Builder{}
|
||||
stderr := &strings.Builder{}
|
||||
cfg, err := NewConfig(stdout, stderr)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal(stdout, cfg.Stdout)
|
||||
suite.Equal(stderr, cfg.Stderr)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestDeprecatedSettingWarnings() {
|
||||
for _, varname := range deprecatedVars {
|
||||
suite.setenv(varname, "deprecoat") // environment-block entries should cause warnings
|
||||
}
|
||||
|
||||
suite.unsetenv("PURGE")
|
||||
suite.setenv("PLUGIN_PURGE", "true") // settings-block entries should cause warnings
|
||||
suite.setenv("UPGRADE", "") // entries should cause warnings even when set to empty string
|
||||
|
||||
stderr := &strings.Builder{}
|
||||
_, err := NewConfig(&strings.Builder{}, stderr)
|
||||
suite.NoError(err)
|
||||
|
||||
for _, varname := range deprecatedVars {
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("Warning: ignoring deprecated '%s' setting\n", strings.ToLower(varname)))
|
||||
}
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestLogDebug() {
|
||||
suite.setenv("DEBUG", "true")
|
||||
suite.setenv("MODE", "upgrade")
|
||||
|
||||
stderr := strings.Builder{}
|
||||
stdout := strings.Builder{}
|
||||
_, err := NewConfig(&stdout, &stderr)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("", stdout.String())
|
||||
|
||||
suite.Regexp(`^Generated config: \{Command:upgrade.*\}`, stderr.String())
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestLogDebugCensorsKubeToken() {
|
||||
stderr := &strings.Builder{}
|
||||
kubeToken := "I'm shy! Don't put me in your build logs!"
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
KubeToken: kubeToken,
|
||||
Stderr: stderr,
|
||||
}
|
||||
|
||||
cfg.logDebug()
|
||||
|
||||
suite.Contains(stderr.String(), "KubeToken:(redacted)")
|
||||
suite.Equal(kubeToken, cfg.KubeToken) // The actual config value should be left unchanged
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithValuesSecrets() {
|
||||
suite.unsetenv("VALUES")
|
||||
suite.unsetenv("STRING_VALUES")
|
||||
suite.unsetenv("SECRET_WATER")
|
||||
suite.setenv("SECRET_FIRE", "Eru_Ilúvatar")
|
||||
suite.setenv("SECRET_RINGS", "1")
|
||||
suite.setenv("PLUGIN_VALUES", "fire=$SECRET_FIRE,water=${SECRET_WATER}")
|
||||
suite.setenv("PLUGIN_STRING_VALUES", "rings=${SECRET_RINGS}")
|
||||
suite.setenv("PLUGIN_ADD_REPOS", "testrepo=https://user:${SECRET_FIRE}@testrepo.test")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("fire=Eru_Ilúvatar,water=", cfg.Values)
|
||||
suite.Equal("rings=1", cfg.StringValues)
|
||||
suite.Equal(fmt.Sprintf("testrepo=https://user:%s@testrepo.test", os.Getenv("SECRET_FIRE")), cfg.AddRepos[0])
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestValuesSecretsWithDebugLogging() {
|
||||
suite.unsetenv("VALUES")
|
||||
suite.unsetenv("SECRET_WATER")
|
||||
suite.setenv("SECRET_FIRE", "Eru_Ilúvatar")
|
||||
suite.setenv("PLUGIN_DEBUG", "true")
|
||||
suite.setenv("PLUGIN_STRING_VALUES", "fire=$SECRET_FIRE")
|
||||
suite.setenv("PLUGIN_VALUES", "fire=$SECRET_FIRE,water=$SECRET_WATER")
|
||||
stderr := strings.Builder{}
|
||||
_, err := NewConfig(&strings.Builder{}, &stderr)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Contains(stderr.String(), "Values:fire=Eru_Ilúvatar,water=")
|
||||
suite.Contains(stderr.String(), `$SECRET_WATER not present in environment, replaced with ""`)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestHistoryMax() {
|
||||
conf := NewTestConfig(suite.T())
|
||||
suite.Assert().Equal(10, conf.HistoryMax)
|
||||
|
||||
suite.setenv("PLUGIN_HISTORY_MAX", "0")
|
||||
conf = NewTestConfig(suite.T())
|
||||
suite.Assert().Equal(0, conf.HistoryMax)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) setenv(key, val string) {
|
||||
orig, ok := os.LookupEnv(key)
|
||||
if ok {
|
||||
suite.envBackup[key] = &orig
|
||||
} else {
|
||||
suite.envBackup[key] = nil
|
||||
}
|
||||
os.Setenv(key, val)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) unsetenv(key string) {
|
||||
orig, ok := os.LookupEnv(key)
|
||||
if ok {
|
||||
suite.envBackup[key] = &orig
|
||||
} else {
|
||||
suite.envBackup[key] = nil
|
||||
}
|
||||
os.Unsetenv(key)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) BeforeTest(_, _ string) {
|
||||
suite.envBackup = make(map[string]*string)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) AfterTest(_, _ string) {
|
||||
for key, val := range suite.envBackup {
|
||||
if val == nil {
|
||||
os.Unsetenv(key)
|
||||
} else {
|
||||
os.Setenv(key, *val)
|
||||
}
|
||||
}
|
||||
}
|
||||
16
internal/env/testing.go
vendored
Normal file
16
internal/env/testing.go
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
package env
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// NewTestConfig is a helper for setting up a Config object and error checking
|
||||
func NewTestConfig(t *testing.T) *Config {
|
||||
conf, err := NewConfig(os.Stdout, os.Stderr)
|
||||
require.NoError(t, err)
|
||||
|
||||
return conf
|
||||
}
|
||||
@@ -1,92 +0,0 @@
|
||||
package helm
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/kelseyhightower/envconfig"
|
||||
"io"
|
||||
"os"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var (
|
||||
justNumbers = regexp.MustCompile(`^\d+$`)
|
||||
deprecatedVars = []string{"PURGE", "RECREATE_PODS", "TILLER_NS", "UPGRADE", "CANARY_IMAGE", "CLIENT_ONLY", "STABLE_REPO_URL"}
|
||||
)
|
||||
|
||||
// The Config struct captures the `settings` and `environment` blocks in the application's drone
|
||||
// config. Configuration in drone's `settings` block arrives as uppercase env vars matching the
|
||||
// config key, prefixed with `PLUGIN_`. Config from the `environment` block is uppercased, but does
|
||||
// not have the `PLUGIN_` prefix.
|
||||
type Config struct {
|
||||
// Configuration for drone-helm itself
|
||||
Command string `envconfig:"HELM_COMMAND"` // Helm command to run
|
||||
DroneEvent string `envconfig:"DRONE_BUILD_EVENT"` // Drone event that invoked this plugin.
|
||||
UpdateDependencies bool `split_words:"true"` // Call `helm dependency update` before the main command
|
||||
AddRepos []string `envconfig:"HELM_REPOS"` // Call `helm repo add` before the main command
|
||||
Debug bool `` // Generate debug output and pass --debug to all helm commands
|
||||
Values string `` // Argument to pass to --set in applicable helm commands
|
||||
StringValues string `split_words:"true"` // Argument to pass to --set-string in applicable helm commands
|
||||
ValuesFiles []string `split_words:"true"` // Arguments to pass to --values in applicable helm commands
|
||||
Namespace string `` // Kubernetes namespace for all helm commands
|
||||
KubeToken string `envconfig:"KUBERNETES_TOKEN"` // Kubernetes authentication token to put in .kube/config
|
||||
SkipTLSVerify bool `envconfig:"SKIP_TLS_VERIFY"` // Put insecure-skip-tls-verify in .kube/config
|
||||
Certificate string `envconfig:"KUBERNETES_CERTIFICATE"` // The Kubernetes cluster CA's self-signed certificate (must be base64-encoded)
|
||||
APIServer string `envconfig:"API_SERVER"` // The Kubernetes cluster's API endpoint
|
||||
ServiceAccount string `split_words:"true"` // Account to use for connecting to the Kubernetes cluster
|
||||
ChartVersion string `split_words:"true"` // Specific chart version to use in `helm upgrade`
|
||||
DryRun bool `split_words:"true"` // Pass --dry-run to applicable helm commands
|
||||
Wait bool `` // Pass --wait to applicable helm commands
|
||||
ReuseValues bool `split_words:"true"` // Pass --reuse-values to `helm upgrade`
|
||||
Timeout string `` // Argument to pass to --timeout in applicable helm commands
|
||||
Chart string `` // Chart argument to use in applicable helm commands
|
||||
Release string `` // Release argument to use in applicable helm commands
|
||||
Force bool `` // Pass --force to applicable helm commands
|
||||
|
||||
Stdout io.Writer `ignored:"true"`
|
||||
Stderr io.Writer `ignored:"true"`
|
||||
}
|
||||
|
||||
// NewConfig creates a Config and reads environment variables into it, accounting for several possible formats.
|
||||
func NewConfig(stdout, stderr io.Writer) (*Config, error) {
|
||||
cfg := Config{
|
||||
Stdout: stdout,
|
||||
Stderr: stderr,
|
||||
}
|
||||
if err := envconfig.Process("plugin", &cfg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := envconfig.Process("", &cfg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if justNumbers.MatchString(cfg.Timeout) {
|
||||
cfg.Timeout = fmt.Sprintf("%ss", cfg.Timeout)
|
||||
}
|
||||
|
||||
if cfg.Debug && cfg.Stderr != nil {
|
||||
cfg.logDebug()
|
||||
}
|
||||
|
||||
cfg.deprecationWarn()
|
||||
|
||||
return &cfg, nil
|
||||
}
|
||||
|
||||
func (cfg Config) logDebug() {
|
||||
if cfg.KubeToken != "" {
|
||||
cfg.KubeToken = "(redacted)"
|
||||
}
|
||||
fmt.Fprintf(cfg.Stderr, "Generated config: %+v\n", cfg)
|
||||
}
|
||||
|
||||
func (cfg *Config) deprecationWarn() {
|
||||
for _, varname := range deprecatedVars {
|
||||
_, barePresent := os.LookupEnv(varname)
|
||||
_, prefixedPresent := os.LookupEnv("PLUGIN_" + varname)
|
||||
if barePresent || prefixedPresent {
|
||||
fmt.Fprintf(cfg.Stderr, "Warning: ignoring deprecated '%s' setting\n", strings.ToLower(varname))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,162 +0,0 @@
|
||||
package helm
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type ConfigTestSuite struct {
|
||||
suite.Suite
|
||||
// These tests need to mutate the environment, so the suite.setenv and .unsetenv functions store the original contents of the
|
||||
// relevant variable in this map. Its use of *string is so they can distinguish between "not set" and "set to empty string"
|
||||
envBackup map[string]*string
|
||||
}
|
||||
|
||||
func TestConfigTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(ConfigTestSuite))
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithPluginPrefix() {
|
||||
suite.unsetenv("HELM_COMMAND")
|
||||
suite.unsetenv("UPDATE_DEPENDENCIES")
|
||||
suite.unsetenv("DEBUG")
|
||||
|
||||
suite.setenv("PLUGIN_HELM_COMMAND", "execute order 66")
|
||||
suite.setenv("PLUGIN_UPDATE_DEPENDENCIES", "true")
|
||||
suite.setenv("PLUGIN_DEBUG", "true")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("execute order 66", cfg.Command)
|
||||
suite.True(cfg.UpdateDependencies)
|
||||
suite.True(cfg.Debug)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithNoPrefix() {
|
||||
suite.unsetenv("PLUGIN_HELM_COMMAND")
|
||||
suite.unsetenv("PLUGIN_UPDATE_DEPENDENCIES")
|
||||
suite.unsetenv("PLUGIN_DEBUG")
|
||||
|
||||
suite.setenv("HELM_COMMAND", "execute order 66")
|
||||
suite.setenv("UPDATE_DEPENDENCIES", "true")
|
||||
suite.setenv("DEBUG", "true")
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("execute order 66", cfg.Command)
|
||||
suite.True(cfg.UpdateDependencies)
|
||||
suite.True(cfg.Debug)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigWithConflictingVariables() {
|
||||
suite.setenv("PLUGIN_HELM_COMMAND", "execute order 66")
|
||||
suite.setenv("HELM_COMMAND", "defend the jedi") // values from the `environment` block override those from `settings`
|
||||
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("defend the jedi", cfg.Command)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigInfersNumbersAreSeconds() {
|
||||
suite.setenv("PLUGIN_TIMEOUT", "42")
|
||||
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("42s", cfg.Timeout)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfigSetsWriters() {
|
||||
stdout := &strings.Builder{}
|
||||
stderr := &strings.Builder{}
|
||||
cfg, err := NewConfig(stdout, stderr)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal(stdout, cfg.Stdout)
|
||||
suite.Equal(stderr, cfg.Stderr)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestDeprecatedSettingWarnings() {
|
||||
for _, varname := range deprecatedVars {
|
||||
suite.setenv(varname, "deprecoat") // environment-block entries should cause warnings
|
||||
}
|
||||
|
||||
suite.unsetenv("PURGE")
|
||||
suite.setenv("PLUGIN_PURGE", "true") // settings-block entries should cause warnings
|
||||
suite.setenv("UPGRADE", "") // entries should cause warnings even when set to empty string
|
||||
|
||||
stderr := &strings.Builder{}
|
||||
_, err := NewConfig(&strings.Builder{}, stderr)
|
||||
suite.NoError(err)
|
||||
|
||||
for _, varname := range deprecatedVars {
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("Warning: ignoring deprecated '%s' setting\n", strings.ToLower(varname)))
|
||||
}
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestLogDebug() {
|
||||
suite.setenv("DEBUG", "true")
|
||||
suite.setenv("HELM_COMMAND", "upgrade")
|
||||
|
||||
stderr := strings.Builder{}
|
||||
stdout := strings.Builder{}
|
||||
_, err := NewConfig(&stdout, &stderr)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
suite.Equal("", stdout.String())
|
||||
|
||||
suite.Regexp(`^Generated config: \{Command:upgrade.*\}`, stderr.String())
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestLogDebugCensorsKubeToken() {
|
||||
stderr := &strings.Builder{}
|
||||
kubeToken := "I'm shy! Don't put me in your build logs!"
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
KubeToken: kubeToken,
|
||||
Stderr: stderr,
|
||||
}
|
||||
|
||||
cfg.logDebug()
|
||||
|
||||
suite.Contains(stderr.String(), "KubeToken:(redacted)")
|
||||
suite.Equal(kubeToken, cfg.KubeToken) // The actual config value should be left unchanged
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) setenv(key, val string) {
|
||||
orig, ok := os.LookupEnv(key)
|
||||
if ok {
|
||||
suite.envBackup[key] = &orig
|
||||
} else {
|
||||
suite.envBackup[key] = nil
|
||||
}
|
||||
os.Setenv(key, val)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) unsetenv(key string) {
|
||||
orig, ok := os.LookupEnv(key)
|
||||
if ok {
|
||||
suite.envBackup[key] = &orig
|
||||
} else {
|
||||
suite.envBackup[key] = nil
|
||||
}
|
||||
os.Unsetenv(key)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) BeforeTest(_, _ string) {
|
||||
suite.envBackup = make(map[string]*string)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) AfterTest(_, _ string) {
|
||||
for key, val := range suite.envBackup {
|
||||
if val == nil {
|
||||
os.Unsetenv(key)
|
||||
} else {
|
||||
os.Setenv(key, *val)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -6,7 +6,6 @@ package helm
|
||||
|
||||
import (
|
||||
gomock "github.com/golang/mock/gomock"
|
||||
run "github.com/pelotech/drone-helm3/internal/run"
|
||||
reflect "reflect"
|
||||
)
|
||||
|
||||
@@ -34,29 +33,29 @@ func (m *MockStep) EXPECT() *MockStepMockRecorder {
|
||||
}
|
||||
|
||||
// Prepare mocks base method
|
||||
func (m *MockStep) Prepare(arg0 run.Config) error {
|
||||
func (m *MockStep) Prepare() error {
|
||||
m.ctrl.T.Helper()
|
||||
ret := m.ctrl.Call(m, "Prepare", arg0)
|
||||
ret := m.ctrl.Call(m, "Prepare")
|
||||
ret0, _ := ret[0].(error)
|
||||
return ret0
|
||||
}
|
||||
|
||||
// Prepare indicates an expected call of Prepare
|
||||
func (mr *MockStepMockRecorder) Prepare(arg0 interface{}) *gomock.Call {
|
||||
func (mr *MockStepMockRecorder) Prepare() *gomock.Call {
|
||||
mr.mock.ctrl.T.Helper()
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Prepare", reflect.TypeOf((*MockStep)(nil).Prepare), arg0)
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Prepare", reflect.TypeOf((*MockStep)(nil).Prepare))
|
||||
}
|
||||
|
||||
// Execute mocks base method
|
||||
func (m *MockStep) Execute(arg0 run.Config) error {
|
||||
func (m *MockStep) Execute() error {
|
||||
m.ctrl.T.Helper()
|
||||
ret := m.ctrl.Call(m, "Execute", arg0)
|
||||
ret := m.ctrl.Call(m, "Execute")
|
||||
ret0, _ := ret[0].(error)
|
||||
return ret0
|
||||
}
|
||||
|
||||
// Execute indicates an expected call of Execute
|
||||
func (mr *MockStepMockRecorder) Execute(arg0 interface{}) *gomock.Call {
|
||||
func (mr *MockStepMockRecorder) Execute() *gomock.Call {
|
||||
mr.mock.ctrl.T.Helper()
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Execute", reflect.TypeOf((*MockStep)(nil).Execute), arg0)
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Execute", reflect.TypeOf((*MockStep)(nil).Execute))
|
||||
}
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
package helm
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/pelotech/drone-helm3/internal/run"
|
||||
"os"
|
||||
)
|
||||
@@ -13,30 +15,24 @@ const (
|
||||
|
||||
// A Step is one step in the plan.
|
||||
type Step interface {
|
||||
Prepare(run.Config) error
|
||||
Execute(run.Config) error
|
||||
Prepare() error
|
||||
Execute() error
|
||||
}
|
||||
|
||||
// A Plan is a series of steps to perform.
|
||||
type Plan struct {
|
||||
steps []Step
|
||||
cfg Config
|
||||
runCfg run.Config
|
||||
cfg env.Config
|
||||
}
|
||||
|
||||
// NewPlan makes a plan for running a helm operation.
|
||||
func NewPlan(cfg Config) (*Plan, error) {
|
||||
func NewPlan(cfg env.Config) (*Plan, error) {
|
||||
p := Plan{
|
||||
cfg: cfg,
|
||||
runCfg: run.Config{
|
||||
Debug: cfg.Debug,
|
||||
Values: cfg.Values,
|
||||
StringValues: cfg.StringValues,
|
||||
ValuesFiles: cfg.ValuesFiles,
|
||||
Namespace: cfg.Namespace,
|
||||
Stdout: cfg.Stdout,
|
||||
Stderr: cfg.Stderr,
|
||||
},
|
||||
}
|
||||
|
||||
if cfg.UpdateDependencies && cfg.DependenciesAction != "" {
|
||||
return nil, errors.New("update_dependencies is deprecated and cannot be provided together with dependencies_action")
|
||||
}
|
||||
|
||||
p.steps = (*determineSteps(cfg))(cfg)
|
||||
@@ -46,7 +42,7 @@ func NewPlan(cfg Config) (*Plan, error) {
|
||||
fmt.Fprintf(os.Stderr, "calling %T.Prepare (step %d)\n", step, i)
|
||||
}
|
||||
|
||||
if err := step.Prepare(p.runCfg); err != nil {
|
||||
if err := step.Prepare(); err != nil {
|
||||
err = fmt.Errorf("while preparing %T step: %w", step, err)
|
||||
return nil, err
|
||||
}
|
||||
@@ -57,7 +53,7 @@ func NewPlan(cfg Config) (*Plan, error) {
|
||||
|
||||
// determineSteps is primarily for the tests' convenience: it allows testing the "which stuff should
|
||||
// we do" logic without building a config that meets all the steps' requirements.
|
||||
func determineSteps(cfg Config) *func(Config) []Step {
|
||||
func determineSteps(cfg env.Config) *func(env.Config) []Step {
|
||||
switch cfg.Command {
|
||||
case "upgrade":
|
||||
return &upgrade
|
||||
@@ -86,7 +82,7 @@ func (p *Plan) Execute() error {
|
||||
fmt.Fprintf(p.cfg.Stderr, "calling %T.Execute (step %d)\n", step, i)
|
||||
}
|
||||
|
||||
if err := step.Execute(p.runCfg); err != nil {
|
||||
if err := step.Execute(); err != nil {
|
||||
return fmt.Errorf("while executing %T step: %w", step, err)
|
||||
}
|
||||
}
|
||||
@@ -94,87 +90,53 @@ func (p *Plan) Execute() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
var upgrade = func(cfg Config) []Step {
|
||||
steps := initKube(cfg)
|
||||
steps = append(steps, addRepos(cfg)...)
|
||||
if cfg.UpdateDependencies {
|
||||
steps = append(steps, depUpdate(cfg)...)
|
||||
var upgrade = func(cfg env.Config) []Step {
|
||||
var steps []Step
|
||||
if !cfg.SkipKubeconfig {
|
||||
steps = append(steps, run.NewInitKube(cfg, kubeConfigTemplate, kubeConfigFile))
|
||||
}
|
||||
steps = append(steps, &run.Upgrade{
|
||||
Chart: cfg.Chart,
|
||||
Release: cfg.Release,
|
||||
ChartVersion: cfg.ChartVersion,
|
||||
DryRun: cfg.DryRun,
|
||||
Wait: cfg.Wait,
|
||||
ReuseValues: cfg.ReuseValues,
|
||||
Timeout: cfg.Timeout,
|
||||
Force: cfg.Force,
|
||||
})
|
||||
|
||||
return steps
|
||||
}
|
||||
|
||||
var uninstall = func(cfg Config) []Step {
|
||||
steps := initKube(cfg)
|
||||
if cfg.UpdateDependencies {
|
||||
steps = append(steps, depUpdate(cfg)...)
|
||||
}
|
||||
steps = append(steps, &run.Uninstall{
|
||||
Release: cfg.Release,
|
||||
DryRun: cfg.DryRun,
|
||||
})
|
||||
|
||||
return steps
|
||||
}
|
||||
|
||||
var lint = func(cfg Config) []Step {
|
||||
steps := addRepos(cfg)
|
||||
if cfg.UpdateDependencies {
|
||||
steps = append(steps, depUpdate(cfg)...)
|
||||
}
|
||||
steps = append(steps, &run.Lint{
|
||||
Chart: cfg.Chart,
|
||||
})
|
||||
|
||||
return steps
|
||||
}
|
||||
|
||||
var help = func(cfg Config) []Step {
|
||||
help := &run.Help{
|
||||
HelmCommand: cfg.Command,
|
||||
}
|
||||
return []Step{help}
|
||||
}
|
||||
|
||||
func initKube(cfg Config) []Step {
|
||||
return []Step{
|
||||
&run.InitKube{
|
||||
SkipTLSVerify: cfg.SkipTLSVerify,
|
||||
Certificate: cfg.Certificate,
|
||||
APIServer: cfg.APIServer,
|
||||
ServiceAccount: cfg.ServiceAccount,
|
||||
Token: cfg.KubeToken,
|
||||
TemplateFile: kubeConfigTemplate,
|
||||
ConfigFile: kubeConfigFile,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func addRepos(cfg Config) []Step {
|
||||
steps := make([]Step, 0)
|
||||
for _, repo := range cfg.AddRepos {
|
||||
steps = append(steps, &run.AddRepo{
|
||||
Repo: repo,
|
||||
})
|
||||
steps = append(steps, run.NewAddRepo(cfg, repo))
|
||||
}
|
||||
|
||||
if cfg.DependenciesAction != "" {
|
||||
steps = append(steps, run.NewDepAction(cfg))
|
||||
}
|
||||
|
||||
if cfg.UpdateDependencies {
|
||||
steps = append(steps, run.NewDepUpdate(cfg))
|
||||
}
|
||||
|
||||
steps = append(steps, run.NewUpgrade(cfg))
|
||||
|
||||
return steps
|
||||
}
|
||||
|
||||
func depUpdate(cfg Config) []Step {
|
||||
return []Step{
|
||||
&run.DepUpdate{
|
||||
Chart: cfg.Chart,
|
||||
},
|
||||
var uninstall = func(cfg env.Config) []Step {
|
||||
var steps []Step
|
||||
if !cfg.SkipKubeconfig {
|
||||
steps = append(steps, run.NewInitKube(cfg, kubeConfigTemplate, kubeConfigFile))
|
||||
}
|
||||
if cfg.UpdateDependencies {
|
||||
steps = append(steps, run.NewDepUpdate(cfg))
|
||||
}
|
||||
steps = append(steps, run.NewUninstall(cfg))
|
||||
|
||||
return steps
|
||||
}
|
||||
|
||||
var lint = func(cfg env.Config) []Step {
|
||||
var steps []Step
|
||||
for _, repo := range cfg.AddRepos {
|
||||
steps = append(steps, run.NewAddRepo(cfg, repo))
|
||||
}
|
||||
if cfg.UpdateDependencies {
|
||||
steps = append(steps, run.NewDepUpdate(cfg))
|
||||
}
|
||||
steps = append(steps, run.NewLint(cfg))
|
||||
return steps
|
||||
}
|
||||
|
||||
var help = func(cfg env.Config) []Step {
|
||||
return []Step{run.NewHelp(cfg)}
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/pelotech/drone-helm3/internal/run"
|
||||
)
|
||||
|
||||
@@ -25,43 +26,29 @@ func (suite *PlanTestSuite) TestNewPlan() {
|
||||
stepTwo := NewMockStep(ctrl)
|
||||
|
||||
origHelp := help
|
||||
help = func(cfg Config) []Step {
|
||||
help = func(cfg env.Config) []Step {
|
||||
return []Step{stepOne, stepTwo}
|
||||
}
|
||||
defer func() { help = origHelp }()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "help",
|
||||
Debug: false,
|
||||
Values: "steadfastness,forthrightness",
|
||||
StringValues: "tensile_strength,flexibility",
|
||||
ValuesFiles: []string{"/root/price_inventory.yml"},
|
||||
Namespace: "outer",
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
runCfg := run.Config{
|
||||
Debug: false,
|
||||
Values: "steadfastness,forthrightness",
|
||||
StringValues: "tensile_strength,flexibility",
|
||||
ValuesFiles: []string{"/root/price_inventory.yml"},
|
||||
Namespace: "outer",
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
stepOne.EXPECT().
|
||||
Prepare(runCfg)
|
||||
Prepare()
|
||||
stepTwo.EXPECT().
|
||||
Prepare(runCfg)
|
||||
Prepare()
|
||||
|
||||
plan, err := NewPlan(cfg)
|
||||
suite.Require().Nil(err)
|
||||
suite.Equal(cfg, plan.cfg)
|
||||
suite.Equal(runCfg, plan.runCfg)
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestNewPlanAbortsOnError() {
|
||||
@@ -71,17 +58,17 @@ func (suite *PlanTestSuite) TestNewPlanAbortsOnError() {
|
||||
stepTwo := NewMockStep(ctrl)
|
||||
|
||||
origHelp := help
|
||||
help = func(cfg Config) []Step {
|
||||
help = func(cfg env.Config) []Step {
|
||||
return []Step{stepOne, stepTwo}
|
||||
}
|
||||
defer func() { help = origHelp }()
|
||||
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "help",
|
||||
}
|
||||
|
||||
stepOne.EXPECT().
|
||||
Prepare(gomock.Any()).
|
||||
Prepare().
|
||||
Return(fmt.Errorf("I'm starry Dave, aye, cat blew that"))
|
||||
|
||||
_, err := NewPlan(cfg)
|
||||
@@ -95,18 +82,15 @@ func (suite *PlanTestSuite) TestExecute() {
|
||||
stepOne := NewMockStep(ctrl)
|
||||
stepTwo := NewMockStep(ctrl)
|
||||
|
||||
runCfg := run.Config{}
|
||||
|
||||
plan := Plan{
|
||||
steps: []Step{stepOne, stepTwo},
|
||||
runCfg: runCfg,
|
||||
}
|
||||
|
||||
stepOne.EXPECT().
|
||||
Execute(runCfg).
|
||||
Execute().
|
||||
Times(1)
|
||||
stepTwo.EXPECT().
|
||||
Execute(runCfg).
|
||||
Execute().
|
||||
Times(1)
|
||||
|
||||
suite.NoError(plan.Execute())
|
||||
@@ -118,15 +102,12 @@ func (suite *PlanTestSuite) TestExecuteAbortsOnError() {
|
||||
stepOne := NewMockStep(ctrl)
|
||||
stepTwo := NewMockStep(ctrl)
|
||||
|
||||
runCfg := run.Config{}
|
||||
|
||||
plan := Plan{
|
||||
steps: []Step{stepOne, stepTwo},
|
||||
runCfg: runCfg,
|
||||
}
|
||||
|
||||
stepOne.EXPECT().
|
||||
Execute(runCfg).
|
||||
Execute().
|
||||
Times(1).
|
||||
Return(fmt.Errorf("oh, he'll gnaw"))
|
||||
|
||||
@@ -135,40 +116,20 @@ func (suite *PlanTestSuite) TestExecuteAbortsOnError() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestUpgrade() {
|
||||
cfg := Config{
|
||||
ChartVersion: "seventeen",
|
||||
DryRun: true,
|
||||
Wait: true,
|
||||
ReuseValues: true,
|
||||
Timeout: "go sit in the corner",
|
||||
Chart: "billboard_top_100",
|
||||
Release: "post_malone_circles",
|
||||
Force: true,
|
||||
}
|
||||
|
||||
steps := upgrade(cfg)
|
||||
steps := upgrade(env.Config{})
|
||||
suite.Require().Equal(2, len(steps), "upgrade should return 2 steps")
|
||||
suite.Require().IsType(&run.InitKube{}, steps[0])
|
||||
|
||||
suite.Require().IsType(&run.Upgrade{}, steps[1])
|
||||
upgrade, _ := steps[1].(*run.Upgrade)
|
||||
|
||||
expected := &run.Upgrade{
|
||||
Chart: cfg.Chart,
|
||||
Release: cfg.Release,
|
||||
ChartVersion: cfg.ChartVersion,
|
||||
DryRun: true,
|
||||
Wait: cfg.Wait,
|
||||
ReuseValues: cfg.ReuseValues,
|
||||
Timeout: cfg.Timeout,
|
||||
Force: cfg.Force,
|
||||
suite.IsType(&run.InitKube{}, steps[0])
|
||||
suite.IsType(&run.Upgrade{}, steps[1])
|
||||
}
|
||||
|
||||
suite.Equal(expected, upgrade)
|
||||
func (suite *PlanTestSuite) TestUpgradeWithSkipKubeconfig() {
|
||||
steps := upgrade(env.Config{SkipKubeconfig: true})
|
||||
suite.Require().Equal(1, len(steps), "upgrade should return 1 step")
|
||||
suite.IsType(&run.Upgrade{}, steps[0])
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestUpgradeWithUpdateDependencies() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
UpdateDependencies: true,
|
||||
}
|
||||
steps := upgrade(cfg)
|
||||
@@ -178,7 +139,7 @@ func (suite *PlanTestSuite) TestUpgradeWithUpdateDependencies() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestUpgradeWithAddRepos() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
AddRepos: []string{
|
||||
"machine=https://github.com/harold_finch/themachine",
|
||||
},
|
||||
@@ -189,45 +150,15 @@ func (suite *PlanTestSuite) TestUpgradeWithAddRepos() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestUninstall() {
|
||||
cfg := Config{
|
||||
KubeToken: "b2YgbXkgYWZmZWN0aW9u",
|
||||
SkipTLSVerify: true,
|
||||
Certificate: "cHJvY2xhaW1zIHdvbmRlcmZ1bCBmcmllbmRzaGlw",
|
||||
APIServer: "98.765.43.21",
|
||||
ServiceAccount: "greathelm",
|
||||
DryRun: true,
|
||||
Timeout: "think about what you did",
|
||||
Release: "jetta_id_love_to_change_the_world",
|
||||
}
|
||||
|
||||
steps := uninstall(cfg)
|
||||
steps := uninstall(env.Config{})
|
||||
suite.Require().Equal(2, len(steps), "uninstall should return 2 steps")
|
||||
|
||||
suite.Require().IsType(&run.InitKube{}, steps[0])
|
||||
init, _ := steps[0].(*run.InitKube)
|
||||
var expected Step = &run.InitKube{
|
||||
SkipTLSVerify: true,
|
||||
Certificate: "cHJvY2xhaW1zIHdvbmRlcmZ1bCBmcmllbmRzaGlw",
|
||||
APIServer: "98.765.43.21",
|
||||
ServiceAccount: "greathelm",
|
||||
Token: "b2YgbXkgYWZmZWN0aW9u",
|
||||
TemplateFile: kubeConfigTemplate,
|
||||
ConfigFile: kubeConfigFile,
|
||||
}
|
||||
|
||||
suite.Equal(expected, init)
|
||||
|
||||
suite.Require().IsType(&run.Uninstall{}, steps[1])
|
||||
actual, _ := steps[1].(*run.Uninstall)
|
||||
expected = &run.Uninstall{
|
||||
Release: "jetta_id_love_to_change_the_world",
|
||||
DryRun: true,
|
||||
}
|
||||
suite.Equal(expected, actual)
|
||||
suite.IsType(&run.InitKube{}, steps[0])
|
||||
suite.IsType(&run.Uninstall{}, steps[1])
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestUninstallWithUpdateDependencies() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
UpdateDependencies: true,
|
||||
}
|
||||
steps := uninstall(cfg)
|
||||
@@ -236,83 +167,14 @@ func (suite *PlanTestSuite) TestUninstallWithUpdateDependencies() {
|
||||
suite.IsType(&run.DepUpdate{}, steps[1])
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestInitKube() {
|
||||
cfg := Config{
|
||||
KubeToken: "cXVlZXIgY2hhcmFjdGVyCg==",
|
||||
SkipTLSVerify: true,
|
||||
Certificate: "b2Ygd29rZW5lc3MK",
|
||||
APIServer: "123.456.78.9",
|
||||
ServiceAccount: "helmet",
|
||||
}
|
||||
|
||||
steps := initKube(cfg)
|
||||
suite.Require().Equal(1, len(steps), "initKube should return one step")
|
||||
suite.Require().IsType(&run.InitKube{}, steps[0])
|
||||
init, _ := steps[0].(*run.InitKube)
|
||||
|
||||
expected := &run.InitKube{
|
||||
SkipTLSVerify: true,
|
||||
Certificate: "b2Ygd29rZW5lc3MK",
|
||||
APIServer: "123.456.78.9",
|
||||
ServiceAccount: "helmet",
|
||||
Token: "cXVlZXIgY2hhcmFjdGVyCg==",
|
||||
TemplateFile: kubeConfigTemplate,
|
||||
ConfigFile: kubeConfigFile,
|
||||
}
|
||||
suite.Equal(expected, init)
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDepUpdate() {
|
||||
cfg := Config{
|
||||
UpdateDependencies: true,
|
||||
Chart: "scatterplot",
|
||||
}
|
||||
|
||||
steps := depUpdate(cfg)
|
||||
suite.Require().Equal(1, len(steps), "depUpdate should return one step")
|
||||
suite.Require().IsType(&run.DepUpdate{}, steps[0])
|
||||
update, _ := steps[0].(*run.DepUpdate)
|
||||
|
||||
expected := &run.DepUpdate{
|
||||
Chart: "scatterplot",
|
||||
}
|
||||
suite.Equal(expected, update)
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestAddRepos() {
|
||||
cfg := Config{
|
||||
AddRepos: []string{
|
||||
"first=https://add.repos/one",
|
||||
"second=https://add.repos/two",
|
||||
},
|
||||
}
|
||||
steps := addRepos(cfg)
|
||||
suite.Require().Equal(2, len(steps), "addRepos should add one step per repo")
|
||||
suite.Require().IsType(&run.AddRepo{}, steps[0])
|
||||
suite.Require().IsType(&run.AddRepo{}, steps[1])
|
||||
first := steps[0].(*run.AddRepo)
|
||||
second := steps[1].(*run.AddRepo)
|
||||
|
||||
suite.Equal(first.Repo, "first=https://add.repos/one")
|
||||
suite.Equal(second.Repo, "second=https://add.repos/two")
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestLint() {
|
||||
cfg := Config{
|
||||
Chart: "./flow",
|
||||
}
|
||||
|
||||
steps := lint(cfg)
|
||||
suite.Equal(1, len(steps))
|
||||
|
||||
want := &run.Lint{
|
||||
Chart: "./flow",
|
||||
}
|
||||
suite.Equal(want, steps[0])
|
||||
steps := lint(env.Config{})
|
||||
suite.Require().Equal(1, len(steps))
|
||||
suite.IsType(&run.Lint{}, steps[0])
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestLintWithUpdateDependencies() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
UpdateDependencies: true,
|
||||
}
|
||||
steps := lint(cfg)
|
||||
@@ -321,7 +183,7 @@ func (suite *PlanTestSuite) TestLintWithUpdateDependencies() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestLintWithAddRepos() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
AddRepos: []string{"friendczar=https://github.com/logan_pierce/friendczar"},
|
||||
}
|
||||
steps := lint(cfg)
|
||||
@@ -330,7 +192,7 @@ func (suite *PlanTestSuite) TestLintWithAddRepos() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDeterminePlanUpgradeCommand() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "upgrade",
|
||||
}
|
||||
stepsMaker := determineSteps(cfg)
|
||||
@@ -338,7 +200,7 @@ func (suite *PlanTestSuite) TestDeterminePlanUpgradeCommand() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDeterminePlanUpgradeFromDroneEvent() {
|
||||
cfg := Config{}
|
||||
cfg := env.Config{}
|
||||
|
||||
upgradeEvents := []string{"push", "tag", "deployment", "pull_request", "promote", "rollback"}
|
||||
for _, event := range upgradeEvents {
|
||||
@@ -349,16 +211,16 @@ func (suite *PlanTestSuite) TestDeterminePlanUpgradeFromDroneEvent() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDeterminePlanUninstallCommand() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "uninstall",
|
||||
}
|
||||
stepsMaker := determineSteps(cfg)
|
||||
suite.Same(&uninstall, stepsMaker)
|
||||
}
|
||||
|
||||
// helm_command = delete is provided as an alias for backwards-compatibility with drone-helm
|
||||
// helm_command = delete is provided as an alias for backward-compatibility with drone-helm
|
||||
func (suite *PlanTestSuite) TestDeterminePlanDeleteCommand() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "delete",
|
||||
}
|
||||
stepsMaker := determineSteps(cfg)
|
||||
@@ -366,7 +228,7 @@ func (suite *PlanTestSuite) TestDeterminePlanDeleteCommand() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDeterminePlanDeleteFromDroneEvent() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
DroneEvent: "delete",
|
||||
}
|
||||
stepsMaker := determineSteps(cfg)
|
||||
@@ -374,7 +236,7 @@ func (suite *PlanTestSuite) TestDeterminePlanDeleteFromDroneEvent() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDeterminePlanLintCommand() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "lint",
|
||||
}
|
||||
|
||||
@@ -383,7 +245,7 @@ func (suite *PlanTestSuite) TestDeterminePlanLintCommand() {
|
||||
}
|
||||
|
||||
func (suite *PlanTestSuite) TestDeterminePlanHelpCommand() {
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Command: "help",
|
||||
}
|
||||
|
||||
|
||||
@@ -2,50 +2,60 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// AddRepo is an execution step that calls `helm repo add` when executed.
|
||||
type AddRepo struct {
|
||||
Repo string
|
||||
*config
|
||||
repo string
|
||||
certs *repoCerts
|
||||
cmd cmd
|
||||
}
|
||||
|
||||
// NewAddRepo creates an AddRepo for the given repo-spec. No validation is performed at this time.
|
||||
func NewAddRepo(cfg env.Config, repo string) *AddRepo {
|
||||
return &AddRepo{
|
||||
config: newConfig(cfg),
|
||||
repo: repo,
|
||||
certs: newRepoCerts(cfg),
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm repo add` command.
|
||||
func (a *AddRepo) Execute(_ Config) error {
|
||||
func (a *AddRepo) Execute() error {
|
||||
return a.cmd.Run()
|
||||
}
|
||||
|
||||
// Prepare gets the AddRepo ready to execute.
|
||||
func (a *AddRepo) Prepare(cfg Config) error {
|
||||
if a.Repo == "" {
|
||||
func (a *AddRepo) Prepare() error {
|
||||
if a.repo == "" {
|
||||
return fmt.Errorf("repo is required")
|
||||
}
|
||||
split := strings.SplitN(a.Repo, "=", 2)
|
||||
split := strings.SplitN(a.repo, "=", 2)
|
||||
if len(split) != 2 {
|
||||
return fmt.Errorf("bad repo spec '%s'", a.Repo)
|
||||
return fmt.Errorf("bad repo spec '%s'", a.repo)
|
||||
}
|
||||
|
||||
if err := a.certs.write(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
name := split[0]
|
||||
url := split[1]
|
||||
|
||||
args := make([]string, 0)
|
||||
|
||||
if cfg.Namespace != "" {
|
||||
args = append(args, "--namespace", cfg.Namespace)
|
||||
}
|
||||
if cfg.Debug {
|
||||
args = append(args, "--debug")
|
||||
}
|
||||
|
||||
args = append(args, "repo", "add", name, url)
|
||||
args := a.globalFlags()
|
||||
args = append(args, "repo", "add")
|
||||
args = append(args, a.certs.flags()...)
|
||||
args = append(args, name, url)
|
||||
|
||||
a.cmd = command(helmBin, args...)
|
||||
a.cmd.Stdout(cfg.Stdout)
|
||||
a.cmd.Stderr(cfg.Stderr)
|
||||
a.cmd.Stdout(a.stdout)
|
||||
a.cmd.Stderr(a.stderr)
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", a.cmd.String())
|
||||
if a.debug {
|
||||
fmt.Fprintf(a.stderr, "Generated command: '%s'\n", a.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
@@ -38,16 +38,22 @@ func TestAddRepoTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(AddRepoTestSuite))
|
||||
}
|
||||
|
||||
func (suite *AddRepoTestSuite) TestNewAddRepo() {
|
||||
repo := NewAddRepo(env.Config{}, "picompress=https://github.com/caleb_phipps/picompress")
|
||||
suite.Require().NotNil(repo)
|
||||
suite.Equal("picompress=https://github.com/caleb_phipps/picompress", repo.repo)
|
||||
suite.NotNil(repo.config)
|
||||
suite.NotNil(repo.certs)
|
||||
}
|
||||
|
||||
func (suite *AddRepoTestSuite) TestPrepareAndExecute() {
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
a := AddRepo{
|
||||
Repo: "edeath=https://github.com/n_marks/e-death",
|
||||
}
|
||||
a := NewAddRepo(cfg, "edeath=https://github.com/n_marks/e-death")
|
||||
|
||||
suite.mockCmd.EXPECT().
|
||||
Stdout(&stdout).
|
||||
@@ -56,7 +62,7 @@ func (suite *AddRepoTestSuite) TestPrepareAndExecute() {
|
||||
Stderr(&stderr).
|
||||
Times(1)
|
||||
|
||||
suite.Require().NoError(a.Prepare(cfg))
|
||||
suite.Require().NoError(a.Prepare())
|
||||
suite.Equal(helmBin, suite.commandPath)
|
||||
suite.Equal([]string{"repo", "add", "edeath", "https://github.com/n_marks/e-death"}, suite.commandArgs)
|
||||
|
||||
@@ -64,7 +70,7 @@ func (suite *AddRepoTestSuite) TestPrepareAndExecute() {
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
suite.Require().NoError(a.Execute(cfg))
|
||||
suite.Require().NoError(a.Execute())
|
||||
|
||||
}
|
||||
|
||||
@@ -72,70 +78,35 @@ func (suite *AddRepoTestSuite) TestPrepareRepoIsRequired() {
|
||||
// These aren't really expected, but allowing them gives clearer test-failure messages
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
cfg := Config{}
|
||||
a := AddRepo{}
|
||||
a := NewAddRepo(env.Config{}, "")
|
||||
|
||||
err := a.Prepare(cfg)
|
||||
err := a.Prepare()
|
||||
suite.EqualError(err, "repo is required")
|
||||
}
|
||||
|
||||
func (suite *AddRepoTestSuite) TestPrepareMalformedRepo() {
|
||||
a := AddRepo{
|
||||
Repo: "dwim",
|
||||
}
|
||||
err := a.Prepare(Config{})
|
||||
a := NewAddRepo(env.Config{}, "dwim")
|
||||
err := a.Prepare()
|
||||
suite.EqualError(err, "bad repo spec 'dwim'")
|
||||
}
|
||||
|
||||
func (suite *AddRepoTestSuite) TestPrepareWithEqualSignInURL() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
a := AddRepo{
|
||||
Repo: "samaritan=https://github.com/arthur_claypool/samaritan?version=2.1",
|
||||
}
|
||||
suite.NoError(a.Prepare(Config{}))
|
||||
a := NewAddRepo(env.Config{}, "samaritan=https://github.com/arthur_claypool/samaritan?version=2.1")
|
||||
suite.NoError(a.Prepare())
|
||||
suite.Contains(suite.commandArgs, "https://github.com/arthur_claypool/samaritan?version=2.1")
|
||||
}
|
||||
|
||||
func (suite *AddRepoTestSuite) TestNamespaceFlag() {
|
||||
func (suite *AddRepoTestSuite) TestRepoAddFlags() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
cfg := Config{
|
||||
Namespace: "alliteration",
|
||||
}
|
||||
a := AddRepo{
|
||||
Repo: "edeath=https://github.com/theater_guy/e-death",
|
||||
}
|
||||
cfg := env.Config{}
|
||||
a := NewAddRepo(cfg, "machine=https://github.com/harold_finch/themachine")
|
||||
|
||||
suite.NoError(a.Prepare(cfg))
|
||||
suite.Equal(suite.commandPath, helmBin)
|
||||
suite.Equal(suite.commandArgs, []string{"--namespace", "alliteration",
|
||||
"repo", "add", "edeath", "https://github.com/theater_guy/e-death"})
|
||||
}
|
||||
|
||||
func (suite *AddRepoTestSuite) TestDebugFlag() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
stderr := strings.Builder{}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.mockCmd.EXPECT().
|
||||
String().
|
||||
Return(fmt.Sprintf("%s %s", path, strings.Join(args, " ")))
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
a := AddRepo{
|
||||
Repo: "edeath=https://github.com/the_bug/e-death",
|
||||
}
|
||||
|
||||
suite.Require().NoError(a.Prepare(cfg))
|
||||
suite.Equal(fmt.Sprintf("Generated command: '%s --debug "+
|
||||
"repo add edeath https://github.com/the_bug/e-death'\n", helmBin), stderr.String())
|
||||
// inject a ca cert filename so repoCerts won't create any files that we'd have to clean up
|
||||
a.certs.caCertFilename = "./helm/reporepo.cert"
|
||||
suite.NoError(a.Prepare())
|
||||
suite.Equal([]string{"repo", "add", "--ca-file", "./helm/reporepo.cert",
|
||||
"machine", "https://github.com/harold_finch/themachine"}, suite.commandArgs)
|
||||
}
|
||||
|
||||
@@ -1,16 +1,33 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"io"
|
||||
)
|
||||
|
||||
// Config contains configuration applicable to all helm commands
|
||||
type Config struct {
|
||||
Debug bool
|
||||
Values string
|
||||
StringValues string
|
||||
ValuesFiles []string
|
||||
Namespace string
|
||||
Stdout io.Writer
|
||||
Stderr io.Writer
|
||||
type config struct {
|
||||
debug bool
|
||||
namespace string
|
||||
stdout io.Writer
|
||||
stderr io.Writer
|
||||
}
|
||||
|
||||
func newConfig(cfg env.Config) *config {
|
||||
return &config{
|
||||
debug: cfg.Debug,
|
||||
namespace: cfg.Namespace,
|
||||
stdout: cfg.Stdout,
|
||||
stderr: cfg.Stderr,
|
||||
}
|
||||
}
|
||||
|
||||
func (cfg *config) globalFlags() []string {
|
||||
flags := []string{}
|
||||
if cfg.debug {
|
||||
flags = append(flags, "--debug")
|
||||
}
|
||||
if cfg.namespace != "" {
|
||||
flags = append(flags, "--namespace", cfg.namespace)
|
||||
}
|
||||
return flags
|
||||
}
|
||||
|
||||
48
internal/run/config_test.go
Normal file
48
internal/run/config_test.go
Normal file
@@ -0,0 +1,48 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type ConfigTestSuite struct {
|
||||
suite.Suite
|
||||
}
|
||||
|
||||
func TestConfigTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(ConfigTestSuite))
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestNewConfig() {
|
||||
stdout := &strings.Builder{}
|
||||
stderr := &strings.Builder{}
|
||||
envCfg := env.Config{
|
||||
Namespace: "private",
|
||||
Debug: true,
|
||||
Stdout: stdout,
|
||||
Stderr: stderr,
|
||||
}
|
||||
cfg := newConfig(envCfg)
|
||||
suite.Require().NotNil(cfg)
|
||||
suite.Equal(&config{
|
||||
namespace: "private",
|
||||
debug: true,
|
||||
stdout: stdout,
|
||||
stderr: stderr,
|
||||
}, cfg)
|
||||
}
|
||||
|
||||
func (suite *ConfigTestSuite) TestGlobalFlags() {
|
||||
cfg := config{
|
||||
debug: true,
|
||||
namespace: "public",
|
||||
}
|
||||
flags := cfg.globalFlags()
|
||||
suite.Equal([]string{"--debug", "--namespace", "public"}, flags)
|
||||
|
||||
cfg = config{}
|
||||
flags = cfg.globalFlags()
|
||||
suite.Equal([]string{}, flags)
|
||||
}
|
||||
59
internal/run/depaction.go
Normal file
59
internal/run/depaction.go
Normal file
@@ -0,0 +1,59 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
const (
|
||||
actionBuild = "build"
|
||||
actionUpdate = "update"
|
||||
)
|
||||
|
||||
// DepAction is an execution step that calls `helm dependency update` or `helm dependency build` when executed.
|
||||
type DepAction struct {
|
||||
*config
|
||||
chart string
|
||||
cmd cmd
|
||||
action string
|
||||
}
|
||||
|
||||
// NewDepAction creates a DepAction using fields from the given Config. No validation is performed at this time.
|
||||
func NewDepAction(cfg env.Config) *DepAction {
|
||||
return &DepAction{
|
||||
config: newConfig(cfg),
|
||||
chart: cfg.Chart,
|
||||
action: cfg.DependenciesAction,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm upgrade` command.
|
||||
func (d *DepAction) Execute() error {
|
||||
return d.cmd.Run()
|
||||
}
|
||||
|
||||
// Prepare gets the DepAction ready to execute.
|
||||
func (d *DepAction) Prepare() error {
|
||||
if d.chart == "" {
|
||||
return fmt.Errorf("chart is required")
|
||||
}
|
||||
|
||||
args := d.globalFlags()
|
||||
|
||||
if d.action != actionBuild && d.action != actionUpdate {
|
||||
return errors.New("unknown dependency_action: " + d.action)
|
||||
}
|
||||
|
||||
args = append(args, "dependency", d.action, d.chart)
|
||||
|
||||
d.cmd = command(helmBin, args...)
|
||||
d.cmd.Stdout(d.stdout)
|
||||
d.cmd.Stderr(d.stderr)
|
||||
|
||||
if d.debug {
|
||||
fmt.Fprintf(d.stderr, "Generated command: '%s'\n", d.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
131
internal/run/depaction_test.go
Normal file
131
internal/run/depaction_test.go
Normal file
@@ -0,0 +1,131 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type DepActionTestSuite struct {
|
||||
suite.Suite
|
||||
ctrl *gomock.Controller
|
||||
mockCmd *Mockcmd
|
||||
originalCommand func(string, ...string) cmd
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) BeforeTest(_, _ string) {
|
||||
suite.ctrl = gomock.NewController(suite.T())
|
||||
suite.mockCmd = NewMockcmd(suite.ctrl)
|
||||
|
||||
suite.originalCommand = command
|
||||
command = func(path string, args ...string) cmd { return suite.mockCmd }
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) AfterTest(_, _ string) {
|
||||
command = suite.originalCommand
|
||||
}
|
||||
|
||||
func TestDepActionTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(DepActionTestSuite))
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) TestNewDepAction() {
|
||||
cfg := env.Config{
|
||||
Chart: "scatterplot",
|
||||
}
|
||||
d := NewDepAction(cfg)
|
||||
suite.Equal("scatterplot", d.chart)
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) TestPrepareAndExecuteBuild() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := env.Config{
|
||||
Chart: "your_top_songs_2019",
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
DependenciesAction: "build",
|
||||
}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
suite.Equal([]string{"dependency", "build", "your_top_songs_2019"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
suite.mockCmd.EXPECT().
|
||||
Stdout(&stdout)
|
||||
suite.mockCmd.EXPECT().
|
||||
Stderr(&stderr)
|
||||
suite.mockCmd.EXPECT().
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
d := NewDepAction(cfg)
|
||||
|
||||
suite.Require().NoError(d.Prepare())
|
||||
suite.NoError(d.Execute())
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) TestPrepareAndExecuteUpdate() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := env.Config{
|
||||
Chart: "your_top_songs_2019",
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
DependenciesAction: "update",
|
||||
}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
suite.Equal([]string{"dependency", "update", "your_top_songs_2019"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
suite.mockCmd.EXPECT().
|
||||
Stdout(&stdout)
|
||||
suite.mockCmd.EXPECT().
|
||||
Stderr(&stderr)
|
||||
suite.mockCmd.EXPECT().
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
d := NewDepAction(cfg)
|
||||
|
||||
suite.Require().NoError(d.Prepare())
|
||||
suite.NoError(d.Execute())
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) TestPrepareAndExecuteUnknown() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := env.Config{
|
||||
Chart: "your_top_songs_2019",
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
DependenciesAction: "downgrade",
|
||||
}
|
||||
|
||||
d := NewDepAction(cfg)
|
||||
suite.Require().Equal(errors.New("unknown dependency_action: downgrade"), d.Prepare())
|
||||
}
|
||||
|
||||
func (suite *DepActionTestSuite) TestPrepareChartRequired() {
|
||||
d := NewDepAction(env.Config{})
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
err := d.Prepare()
|
||||
suite.EqualError(err, "chart is required")
|
||||
}
|
||||
@@ -2,42 +2,44 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
// DepUpdate is an execution step that calls `helm dependency update` when executed.
|
||||
type DepUpdate struct {
|
||||
Chart string
|
||||
*config
|
||||
chart string
|
||||
cmd cmd
|
||||
}
|
||||
|
||||
// NewDepUpdate creates a DepUpdate using fields from the given Config. No validation is performed at this time.
|
||||
func NewDepUpdate(cfg env.Config) *DepUpdate {
|
||||
return &DepUpdate{
|
||||
config: newConfig(cfg),
|
||||
chart: cfg.Chart,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm upgrade` command.
|
||||
func (d *DepUpdate) Execute(_ Config) error {
|
||||
func (d *DepUpdate) Execute() error {
|
||||
return d.cmd.Run()
|
||||
}
|
||||
|
||||
// Prepare gets the DepUpdate ready to execute.
|
||||
func (d *DepUpdate) Prepare(cfg Config) error {
|
||||
if d.Chart == "" {
|
||||
func (d *DepUpdate) Prepare() error {
|
||||
if d.chart == "" {
|
||||
return fmt.Errorf("chart is required")
|
||||
}
|
||||
|
||||
args := make([]string, 0)
|
||||
|
||||
if cfg.Namespace != "" {
|
||||
args = append(args, "--namespace", cfg.Namespace)
|
||||
}
|
||||
if cfg.Debug {
|
||||
args = append(args, "--debug")
|
||||
}
|
||||
|
||||
args = append(args, "dependency", "update", d.Chart)
|
||||
args := d.globalFlags()
|
||||
args = append(args, "dependency", "update", d.chart)
|
||||
|
||||
d.cmd = command(helmBin, args...)
|
||||
d.cmd.Stdout(cfg.Stdout)
|
||||
d.cmd.Stderr(cfg.Stderr)
|
||||
d.cmd.Stdout(d.stdout)
|
||||
d.cmd.Stderr(d.stderr)
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", d.cmd.String())
|
||||
if d.debug {
|
||||
fmt.Fprintf(d.stderr, "Generated command: '%s'\n", d.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
@@ -31,12 +31,21 @@ func TestDepUpdateTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(DepUpdateTestSuite))
|
||||
}
|
||||
|
||||
func (suite *DepUpdateTestSuite) TestNewDepUpdate() {
|
||||
cfg := env.Config{
|
||||
Chart: "scatterplot",
|
||||
}
|
||||
d := NewDepUpdate(cfg)
|
||||
suite.Equal("scatterplot", d.chart)
|
||||
}
|
||||
|
||||
func (suite *DepUpdateTestSuite) TestPrepareAndExecute() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Chart: "your_top_songs_2019",
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
@@ -55,74 +64,18 @@ func (suite *DepUpdateTestSuite) TestPrepareAndExecute() {
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
d := DepUpdate{
|
||||
Chart: "your_top_songs_2019",
|
||||
}
|
||||
d := NewDepUpdate(cfg)
|
||||
|
||||
suite.Require().NoError(d.Prepare(cfg))
|
||||
suite.NoError(d.Execute(cfg))
|
||||
}
|
||||
|
||||
func (suite *DepUpdateTestSuite) TestPrepareNamespaceFlag() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
cfg := Config{
|
||||
Namespace: "spotify",
|
||||
}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal([]string{"--namespace", "spotify", "dependency", "update", "your_top_songs_2019"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
d := DepUpdate{
|
||||
Chart: "your_top_songs_2019",
|
||||
}
|
||||
|
||||
suite.Require().NoError(d.Prepare(cfg))
|
||||
}
|
||||
|
||||
func (suite *DepUpdateTestSuite) TestPrepareDebugFlag() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.mockCmd.EXPECT().
|
||||
String().
|
||||
Return(fmt.Sprintf("%s %s", path, strings.Join(args, " ")))
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
d := DepUpdate{
|
||||
Chart: "your_top_songs_2019",
|
||||
}
|
||||
|
||||
suite.Require().NoError(d.Prepare(cfg))
|
||||
|
||||
want := fmt.Sprintf("Generated command: '%s --debug dependency update your_top_songs_2019'\n", helmBin)
|
||||
suite.Equal(want, stderr.String())
|
||||
suite.Equal("", stdout.String())
|
||||
suite.Require().NoError(d.Prepare())
|
||||
suite.NoError(d.Execute())
|
||||
}
|
||||
|
||||
func (suite *DepUpdateTestSuite) TestPrepareChartRequired() {
|
||||
d := DepUpdate{}
|
||||
d := NewDepUpdate(env.Config{})
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
err := d.Prepare(Config{})
|
||||
err := d.Prepare()
|
||||
suite.EqualError(err, "chart is required")
|
||||
}
|
||||
|
||||
@@ -2,39 +2,47 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
// Help is a step in a helm Plan that calls `helm help`.
|
||||
type Help struct {
|
||||
HelmCommand string
|
||||
*config
|
||||
helmCommand string
|
||||
cmd cmd
|
||||
}
|
||||
|
||||
// NewHelp creates a Help using fields from the given Config. No validation is performed at this time.
|
||||
func NewHelp(cfg env.Config) *Help {
|
||||
return &Help{
|
||||
config: newConfig(cfg),
|
||||
helmCommand: cfg.Command,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm help` command.
|
||||
func (h *Help) Execute(cfg Config) error {
|
||||
func (h *Help) Execute() error {
|
||||
if err := h.cmd.Run(); err != nil {
|
||||
return fmt.Errorf("while running '%s': %w", h.cmd.String(), err)
|
||||
}
|
||||
|
||||
if h.HelmCommand == "help" {
|
||||
if h.helmCommand == "help" {
|
||||
return nil
|
||||
}
|
||||
return fmt.Errorf("unknown command '%s'", h.HelmCommand)
|
||||
return fmt.Errorf("unknown command '%s'", h.helmCommand)
|
||||
}
|
||||
|
||||
// Prepare gets the Help ready to execute.
|
||||
func (h *Help) Prepare(cfg Config) error {
|
||||
args := []string{"help"}
|
||||
if cfg.Debug {
|
||||
args = append([]string{"--debug"}, args...)
|
||||
}
|
||||
func (h *Help) Prepare() error {
|
||||
args := h.globalFlags()
|
||||
args = append(args, "help")
|
||||
|
||||
h.cmd = command(helmBin, args...)
|
||||
h.cmd.Stdout(cfg.Stdout)
|
||||
h.cmd.Stderr(cfg.Stderr)
|
||||
h.cmd.Stdout(h.stdout)
|
||||
h.cmd.Stderr(h.stderr)
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", h.cmd.String())
|
||||
if h.debug {
|
||||
fmt.Fprintf(h.stderr, "Generated command: '%s'\n", h.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
@@ -17,6 +17,15 @@ func TestHelpTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(HelpTestSuite))
|
||||
}
|
||||
|
||||
func (suite *HelpTestSuite) TestNewHelp() {
|
||||
cfg := env.Config{
|
||||
Command: "everybody dance NOW!!",
|
||||
}
|
||||
help := NewHelp(cfg)
|
||||
suite.Require().NotNil(help)
|
||||
suite.Equal("everybody dance NOW!!", help.helmCommand)
|
||||
}
|
||||
|
||||
func (suite *HelpTestSuite) TestPrepare() {
|
||||
ctrl := gomock.NewController(suite.T())
|
||||
defer ctrl.Finish()
|
||||
@@ -39,13 +48,13 @@ func (suite *HelpTestSuite) TestPrepare() {
|
||||
mCmd.EXPECT().
|
||||
Stderr(&stderr)
|
||||
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
h := Help{}
|
||||
err := h.Prepare(cfg)
|
||||
h := NewHelp(cfg)
|
||||
err := h.Prepare()
|
||||
suite.NoError(err)
|
||||
}
|
||||
|
||||
@@ -53,41 +62,15 @@ func (suite *HelpTestSuite) TestExecute() {
|
||||
ctrl := gomock.NewController(suite.T())
|
||||
defer ctrl.Finish()
|
||||
mCmd := NewMockcmd(ctrl)
|
||||
originalCommand := command
|
||||
command = func(_ string, _ ...string) cmd {
|
||||
return mCmd
|
||||
}
|
||||
defer func() { command = originalCommand }()
|
||||
|
||||
mCmd.EXPECT().
|
||||
Run().
|
||||
Times(2)
|
||||
|
||||
cfg := Config{}
|
||||
help := Help{
|
||||
HelmCommand: "help",
|
||||
cmd: mCmd,
|
||||
}
|
||||
suite.NoError(help.Execute(cfg))
|
||||
|
||||
help.HelmCommand = "get down on friday"
|
||||
suite.EqualError(help.Execute(cfg), "unknown command 'get down on friday'")
|
||||
}
|
||||
|
||||
func (suite *HelpTestSuite) TestPrepareDebugFlag() {
|
||||
help := Help{}
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
help.Prepare(cfg)
|
||||
|
||||
want := fmt.Sprintf("Generated command: '%s --debug help'\n", helmBin)
|
||||
suite.Equal(want, stderr.String())
|
||||
suite.Equal("", stdout.String())
|
||||
help := NewHelp(env.Config{Command: "help"})
|
||||
help.cmd = mCmd
|
||||
suite.NoError(help.Execute())
|
||||
|
||||
help.helmCommand = "get down on friday"
|
||||
suite.EqualError(help.Execute(), "unknown command 'get down on friday'")
|
||||
}
|
||||
|
||||
@@ -6,18 +6,15 @@ import (
|
||||
"io"
|
||||
"os"
|
||||
"text/template"
|
||||
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
// InitKube is a step in a helm Plan that initializes the kubernetes config file.
|
||||
type InitKube struct {
|
||||
SkipTLSVerify bool
|
||||
Certificate string
|
||||
APIServer string
|
||||
ServiceAccount string
|
||||
Token string
|
||||
TemplateFile string
|
||||
ConfigFile string
|
||||
|
||||
*config
|
||||
templateFilename string
|
||||
configFilename string
|
||||
template *template.Template
|
||||
configFile io.WriteCloser
|
||||
values kubeValues
|
||||
@@ -32,58 +29,66 @@ type kubeValues struct {
|
||||
Token string
|
||||
}
|
||||
|
||||
// NewInitKube creates a InitKube using the given Config and filepaths. No validation is performed at this time.
|
||||
func NewInitKube(cfg env.Config, templateFile, configFile string) *InitKube {
|
||||
return &InitKube{
|
||||
config: newConfig(cfg),
|
||||
values: kubeValues{
|
||||
SkipTLSVerify: cfg.SkipTLSVerify,
|
||||
Certificate: cfg.Certificate,
|
||||
APIServer: cfg.APIServer,
|
||||
Namespace: cfg.Namespace,
|
||||
ServiceAccount: cfg.ServiceAccount,
|
||||
Token: cfg.KubeToken,
|
||||
},
|
||||
templateFilename: templateFile,
|
||||
configFilename: configFile,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute generates a kubernetes config file from drone-helm3's template.
|
||||
func (i *InitKube) Execute(cfg Config) error {
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "writing kubeconfig file to %s\n", i.ConfigFile)
|
||||
func (i *InitKube) Execute() error {
|
||||
if i.debug {
|
||||
fmt.Fprintf(i.stderr, "writing kubeconfig file to %s\n", i.configFilename)
|
||||
}
|
||||
defer i.configFile.Close()
|
||||
return i.template.Execute(i.configFile, i.values)
|
||||
}
|
||||
|
||||
// Prepare ensures all required configuration is present and that the config file is writable.
|
||||
func (i *InitKube) Prepare(cfg Config) error {
|
||||
func (i *InitKube) Prepare() error {
|
||||
var err error
|
||||
|
||||
if i.APIServer == "" {
|
||||
if i.values.APIServer == "" {
|
||||
return errors.New("an API Server is needed to deploy")
|
||||
}
|
||||
if i.Token == "" {
|
||||
if i.values.Token == "" {
|
||||
return errors.New("token is needed to deploy")
|
||||
}
|
||||
|
||||
if i.ServiceAccount == "" {
|
||||
i.ServiceAccount = "helm"
|
||||
if i.values.ServiceAccount == "" {
|
||||
i.values.ServiceAccount = "helm"
|
||||
}
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "loading kubeconfig template from %s\n", i.TemplateFile)
|
||||
if i.debug {
|
||||
fmt.Fprintf(i.stderr, "loading kubeconfig template from %s\n", i.templateFilename)
|
||||
}
|
||||
i.template, err = template.ParseFiles(i.TemplateFile)
|
||||
i.template, err = template.ParseFiles(i.templateFilename)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not load kubeconfig template: %w", err)
|
||||
}
|
||||
|
||||
i.values = kubeValues{
|
||||
SkipTLSVerify: i.SkipTLSVerify,
|
||||
Certificate: i.Certificate,
|
||||
APIServer: i.APIServer,
|
||||
ServiceAccount: i.ServiceAccount,
|
||||
Token: i.Token,
|
||||
Namespace: cfg.Namespace,
|
||||
}
|
||||
|
||||
if cfg.Debug {
|
||||
if _, err := os.Stat(i.ConfigFile); err != nil {
|
||||
if i.debug {
|
||||
if _, err := os.Stat(i.configFilename); err != nil {
|
||||
// non-nil err here isn't an actual error state; the kubeconfig just doesn't exist
|
||||
fmt.Fprint(cfg.Stderr, "creating ")
|
||||
fmt.Fprint(i.stderr, "creating ")
|
||||
} else {
|
||||
fmt.Fprint(cfg.Stderr, "truncating ")
|
||||
fmt.Fprint(i.stderr, "truncating ")
|
||||
}
|
||||
fmt.Fprintf(cfg.Stderr, "kubeconfig file at %s\n", i.ConfigFile)
|
||||
fmt.Fprintf(i.stderr, "kubeconfig file at %s\n", i.configFilename)
|
||||
}
|
||||
|
||||
i.configFile, err = os.Create(i.ConfigFile)
|
||||
i.configFile, err = os.OpenFile(i.configFilename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not open kubeconfig file for writing: %w", err)
|
||||
}
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
yaml "gopkg.in/yaml.v2"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"text/template"
|
||||
)
|
||||
@@ -17,6 +20,30 @@ func TestInitKubeTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(InitKubeTestSuite))
|
||||
}
|
||||
|
||||
func (suite *InitKubeTestSuite) TestNewInitKube() {
|
||||
cfg := env.Config{
|
||||
SkipTLSVerify: true,
|
||||
Certificate: "cHJvY2xhaW1zIHdvbmRlcmZ1bCBmcmllbmRzaGlw",
|
||||
APIServer: "98.765.43.21",
|
||||
ServiceAccount: "greathelm",
|
||||
KubeToken: "b2YgbXkgYWZmZWN0aW9u",
|
||||
Stderr: &strings.Builder{},
|
||||
Debug: true,
|
||||
}
|
||||
|
||||
init := NewInitKube(cfg, "conf.tpl", "conf.yml")
|
||||
suite.Equal(kubeValues{
|
||||
SkipTLSVerify: true,
|
||||
Certificate: "cHJvY2xhaW1zIHdvbmRlcmZ1bCBmcmllbmRzaGlw",
|
||||
APIServer: "98.765.43.21",
|
||||
ServiceAccount: "greathelm",
|
||||
Token: "b2YgbXkgYWZmZWN0aW9u",
|
||||
}, init.values)
|
||||
suite.Equal("conf.tpl", init.templateFilename)
|
||||
suite.Equal("conf.yml", init.configFilename)
|
||||
suite.NotNil(init.config)
|
||||
}
|
||||
|
||||
func (suite *InitKubeTestSuite) TestPrepareExecute() {
|
||||
templateFile, err := tempfile("kubeconfig********.yml.tpl", `
|
||||
certificate: {{ .Certificate }}
|
||||
@@ -29,23 +56,20 @@ namespace: {{ .Namespace }}
|
||||
defer os.Remove(configFile.Name())
|
||||
suite.Require().Nil(err)
|
||||
|
||||
init := InitKube{
|
||||
cfg := env.Config{
|
||||
APIServer: "Sysadmin",
|
||||
Certificate: "CCNA",
|
||||
Token: "Aspire virtual currency",
|
||||
TemplateFile: templateFile.Name(),
|
||||
ConfigFile: configFile.Name(),
|
||||
}
|
||||
cfg := Config{
|
||||
KubeToken: "Aspire virtual currency",
|
||||
Namespace: "Cisco",
|
||||
}
|
||||
err = init.Prepare(cfg)
|
||||
init := NewInitKube(cfg, templateFile.Name(), configFile.Name())
|
||||
err = init.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
|
||||
suite.IsType(&template.Template{}, init.template)
|
||||
suite.NotNil(init.configFile)
|
||||
|
||||
err = init.Execute(cfg)
|
||||
err = init.Execute()
|
||||
suite.Require().Nil(err)
|
||||
|
||||
conf, err := ioutil.ReadFile(configFile.Name())
|
||||
@@ -63,19 +87,16 @@ func (suite *InitKubeTestSuite) TestExecuteGeneratesConfig() {
|
||||
defer os.Remove(configFile.Name())
|
||||
suite.Require().NoError(err)
|
||||
|
||||
cfg := Config{
|
||||
Namespace: "marshmallow",
|
||||
}
|
||||
init := InitKube{
|
||||
ConfigFile: configFile.Name(),
|
||||
TemplateFile: "../../assets/kubeconfig.tpl", // the actual kubeconfig template
|
||||
cfg := env.Config{
|
||||
APIServer: "https://kube.cluster/peanut",
|
||||
ServiceAccount: "chef",
|
||||
Token: "eWVhaCB3ZSB0b2tpbic=",
|
||||
KubeToken: "eWVhaCB3ZSB0b2tpbic=",
|
||||
Certificate: "d293LCB5b3UgYXJlIHNvIGNvb2wgZm9yIHNtb2tpbmcgd2VlZCDwn5mE",
|
||||
Namespace: "marshmallow",
|
||||
}
|
||||
suite.Require().NoError(init.Prepare(cfg))
|
||||
suite.Require().NoError(init.Execute(cfg))
|
||||
init := NewInitKube(cfg, "../../assets/kubeconfig.tpl", configFile.Name()) // the actual kubeconfig template
|
||||
suite.Require().NoError(init.Prepare())
|
||||
suite.Require().NoError(init.Execute())
|
||||
|
||||
contents, err := ioutil.ReadFile(configFile.Name())
|
||||
suite.Require().NoError(err)
|
||||
@@ -98,11 +119,11 @@ func (suite *InitKubeTestSuite) TestExecuteGeneratesConfig() {
|
||||
suite.NoError(yaml.UnmarshalStrict(contents, &conf))
|
||||
|
||||
// test the other branch of the certificate/SkipTLSVerify conditional
|
||||
init.SkipTLSVerify = true
|
||||
init.Certificate = ""
|
||||
init.values.SkipTLSVerify = true
|
||||
init.values.Certificate = ""
|
||||
|
||||
suite.Require().NoError(init.Prepare(cfg))
|
||||
suite.Require().NoError(init.Execute(cfg))
|
||||
suite.Require().NoError(init.Prepare())
|
||||
suite.Require().NoError(init.Execute())
|
||||
contents, err = ioutil.ReadFile(configFile.Name())
|
||||
suite.Require().NoError(err)
|
||||
suite.Contains(string(contents), "insecure-skip-tls-verify: true")
|
||||
@@ -116,25 +137,25 @@ func (suite *InitKubeTestSuite) TestPrepareParseError() {
|
||||
defer os.Remove(templateFile.Name())
|
||||
suite.Require().Nil(err)
|
||||
|
||||
init := InitKube{
|
||||
cfg := env.Config{
|
||||
APIServer: "Sysadmin",
|
||||
Certificate: "CCNA",
|
||||
Token: "Aspire virtual currency",
|
||||
TemplateFile: templateFile.Name(),
|
||||
KubeToken: "Aspire virtual currency",
|
||||
}
|
||||
err = init.Prepare(Config{})
|
||||
init := NewInitKube(cfg, templateFile.Name(), "")
|
||||
err = init.Prepare()
|
||||
suite.Error(err)
|
||||
suite.Regexp("could not load kubeconfig .* function .* not defined", err)
|
||||
}
|
||||
|
||||
func (suite *InitKubeTestSuite) TestPrepareNonexistentTemplateFile() {
|
||||
init := InitKube{
|
||||
cfg := env.Config{
|
||||
APIServer: "Sysadmin",
|
||||
Certificate: "CCNA",
|
||||
Token: "Aspire virtual currency",
|
||||
TemplateFile: "/usr/foreign/exclude/kubeprofig.tpl",
|
||||
KubeToken: "Aspire virtual currency",
|
||||
}
|
||||
err := init.Prepare(Config{})
|
||||
init := NewInitKube(cfg, "/usr/foreign/exclude/kubeprofig.tpl", "")
|
||||
err := init.Prepare()
|
||||
suite.Error(err)
|
||||
suite.Regexp("could not load kubeconfig .* no such file or directory", err)
|
||||
}
|
||||
@@ -143,16 +164,14 @@ func (suite *InitKubeTestSuite) TestPrepareCannotOpenDestinationFile() {
|
||||
templateFile, err := tempfile("kubeconfig********.yml.tpl", "hurgity burgity")
|
||||
defer os.Remove(templateFile.Name())
|
||||
suite.Require().Nil(err)
|
||||
init := InitKube{
|
||||
cfg := env.Config{
|
||||
APIServer: "Sysadmin",
|
||||
Certificate: "CCNA",
|
||||
Token: "Aspire virtual currency",
|
||||
TemplateFile: templateFile.Name(),
|
||||
ConfigFile: "/usr/foreign/exclude/kubeprofig",
|
||||
KubeToken: "Aspire virtual currency",
|
||||
}
|
||||
init := NewInitKube(cfg, templateFile.Name(), "/usr/foreign/exclude/kubeprofig")
|
||||
|
||||
cfg := Config{}
|
||||
err = init.Prepare(cfg)
|
||||
err = init.Prepare()
|
||||
suite.Error(err)
|
||||
suite.Regexp("could not open .* for writing: .* no such file or directory", err)
|
||||
}
|
||||
@@ -167,24 +186,21 @@ func (suite *InitKubeTestSuite) TestPrepareRequiredConfig() {
|
||||
suite.Require().Nil(err)
|
||||
|
||||
// initial config with all required fields present
|
||||
init := InitKube{
|
||||
cfg := env.Config{
|
||||
APIServer: "Sysadmin",
|
||||
Certificate: "CCNA",
|
||||
Token: "Aspire virtual currency",
|
||||
TemplateFile: templateFile.Name(),
|
||||
ConfigFile: configFile.Name(),
|
||||
KubeToken: "Aspire virtual currency",
|
||||
}
|
||||
|
||||
cfg := Config{}
|
||||
init := NewInitKube(cfg, templateFile.Name(), configFile.Name())
|
||||
suite.NoError(init.Prepare()) // consistency check; we should be starting in a happy state
|
||||
|
||||
suite.NoError(init.Prepare(cfg)) // consistency check; we should be starting in a happy state
|
||||
init.values.APIServer = ""
|
||||
suite.Error(init.Prepare(), "APIServer should be required.")
|
||||
|
||||
init.APIServer = ""
|
||||
suite.Error(init.Prepare(cfg), "APIServer should be required.")
|
||||
|
||||
init.APIServer = "Sysadmin"
|
||||
init.Token = ""
|
||||
suite.Error(init.Prepare(cfg), "Token should be required.")
|
||||
init.values.APIServer = "Sysadmin"
|
||||
init.values.Token = ""
|
||||
suite.Error(init.Prepare(), "Token should be required.")
|
||||
}
|
||||
|
||||
func (suite *InitKubeTestSuite) TestPrepareDefaultsServiceAccount() {
|
||||
@@ -196,18 +212,43 @@ func (suite *InitKubeTestSuite) TestPrepareDefaultsServiceAccount() {
|
||||
defer os.Remove(configFile.Name())
|
||||
suite.Require().Nil(err)
|
||||
|
||||
init := InitKube{
|
||||
cfg := env.Config{
|
||||
APIServer: "Sysadmin",
|
||||
Certificate: "CCNA",
|
||||
Token: "Aspire virtual currency",
|
||||
TemplateFile: templateFile.Name(),
|
||||
ConfigFile: configFile.Name(),
|
||||
KubeToken: "Aspire virtual currency",
|
||||
}
|
||||
init := NewInitKube(cfg, templateFile.Name(), configFile.Name())
|
||||
|
||||
init.Prepare()
|
||||
suite.Equal("helm", init.values.ServiceAccount)
|
||||
}
|
||||
|
||||
cfg := Config{}
|
||||
func (suite *InitKubeTestSuite) TestDebugOutput() {
|
||||
templateFile, err := tempfile("kubeconfig********.yml.tpl", "hurgity burgity")
|
||||
defer os.Remove(templateFile.Name())
|
||||
suite.Require().Nil(err)
|
||||
|
||||
init.Prepare(cfg)
|
||||
suite.Equal("helm", init.ServiceAccount)
|
||||
configFile, err := tempfile("kubeconfig********.yml", "")
|
||||
defer os.Remove(configFile.Name())
|
||||
suite.Require().Nil(err)
|
||||
|
||||
stdout := &strings.Builder{}
|
||||
stderr := &strings.Builder{}
|
||||
cfg := env.Config{
|
||||
APIServer: "http://my.kube.server/",
|
||||
KubeToken: "QSBzaW5nbGUgcm9zZQ==",
|
||||
Debug: true,
|
||||
Stdout: stdout,
|
||||
Stderr: stderr,
|
||||
}
|
||||
init := NewInitKube(cfg, templateFile.Name(), configFile.Name())
|
||||
suite.NoError(init.Prepare())
|
||||
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("loading kubeconfig template from %s\n", templateFile.Name()))
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("truncating kubeconfig file at %s\n", configFile.Name()))
|
||||
|
||||
suite.NoError(init.Execute())
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("writing kubeconfig file to %s\n", configFile.Name()))
|
||||
}
|
||||
|
||||
func tempfile(name, contents string) (*os.File, error) {
|
||||
|
||||
@@ -2,54 +2,67 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
// Lint is an execution step that calls `helm lint` when executed.
|
||||
type Lint struct {
|
||||
Chart string
|
||||
*config
|
||||
chart string
|
||||
values string
|
||||
stringValues string
|
||||
valuesFiles []string
|
||||
strict bool
|
||||
cmd cmd
|
||||
}
|
||||
|
||||
// NewLint creates a Lint using fields from the given Config. No validation is performed at this time.
|
||||
func NewLint(cfg env.Config) *Lint {
|
||||
return &Lint{
|
||||
config: newConfig(cfg),
|
||||
chart: cfg.Chart,
|
||||
values: cfg.Values,
|
||||
stringValues: cfg.StringValues,
|
||||
valuesFiles: cfg.ValuesFiles,
|
||||
strict: cfg.LintStrictly,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm lint` command.
|
||||
func (l *Lint) Execute(_ Config) error {
|
||||
func (l *Lint) Execute() error {
|
||||
return l.cmd.Run()
|
||||
}
|
||||
|
||||
// Prepare gets the Lint ready to execute.
|
||||
func (l *Lint) Prepare(cfg Config) error {
|
||||
if l.Chart == "" {
|
||||
func (l *Lint) Prepare() error {
|
||||
if l.chart == "" {
|
||||
return fmt.Errorf("chart is required")
|
||||
}
|
||||
|
||||
args := make([]string, 0)
|
||||
|
||||
if cfg.Namespace != "" {
|
||||
args = append(args, "--namespace", cfg.Namespace)
|
||||
}
|
||||
if cfg.Debug {
|
||||
args = append(args, "--debug")
|
||||
}
|
||||
|
||||
args := l.globalFlags()
|
||||
args = append(args, "lint")
|
||||
|
||||
if cfg.Values != "" {
|
||||
args = append(args, "--set", cfg.Values)
|
||||
if l.values != "" {
|
||||
args = append(args, "--set", l.values)
|
||||
}
|
||||
if cfg.StringValues != "" {
|
||||
args = append(args, "--set-string", cfg.StringValues)
|
||||
if l.stringValues != "" {
|
||||
args = append(args, "--set-string", l.stringValues)
|
||||
}
|
||||
for _, vFile := range cfg.ValuesFiles {
|
||||
for _, vFile := range l.valuesFiles {
|
||||
args = append(args, "--values", vFile)
|
||||
}
|
||||
if l.strict {
|
||||
args = append(args, "--strict")
|
||||
}
|
||||
|
||||
args = append(args, l.Chart)
|
||||
args = append(args, l.chart)
|
||||
|
||||
l.cmd = command(helmBin, args...)
|
||||
l.cmd.Stdout(cfg.Stdout)
|
||||
l.cmd.Stderr(cfg.Stderr)
|
||||
l.cmd.Stdout(l.stdout)
|
||||
l.cmd.Stderr(l.stderr)
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", l.cmd.String())
|
||||
if l.debug {
|
||||
fmt.Fprintf(l.stderr, "Generated command: '%s'\n", l.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
@@ -31,19 +31,36 @@ func TestLintTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(LintTestSuite))
|
||||
}
|
||||
|
||||
func (suite *LintTestSuite) TestNewLint() {
|
||||
cfg := env.Config{
|
||||
Chart: "./flow",
|
||||
Values: "steadfastness,forthrightness",
|
||||
StringValues: "tensile_strength,flexibility",
|
||||
ValuesFiles: []string{"/root/price_inventory.yml"},
|
||||
LintStrictly: true,
|
||||
}
|
||||
lint := NewLint(cfg)
|
||||
suite.Require().NotNil(lint)
|
||||
suite.Equal("./flow", lint.chart)
|
||||
suite.Equal("steadfastness,forthrightness", lint.values)
|
||||
suite.Equal("tensile_strength,flexibility", lint.stringValues)
|
||||
suite.Equal([]string{"/root/price_inventory.yml"}, lint.valuesFiles)
|
||||
suite.Equal(true, lint.strict)
|
||||
suite.NotNil(lint.config)
|
||||
}
|
||||
|
||||
func (suite *LintTestSuite) TestPrepareAndExecute() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
|
||||
l := Lint{
|
||||
cfg := env.Config{
|
||||
Chart: "./epic/mychart",
|
||||
}
|
||||
cfg := Config{
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
l := NewLint(cfg)
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
@@ -52,6 +69,7 @@ func (suite *LintTestSuite) TestPrepareAndExecute() {
|
||||
return suite.mockCmd
|
||||
}
|
||||
|
||||
suite.mockCmd.EXPECT().String().AnyTimes()
|
||||
suite.mockCmd.EXPECT().
|
||||
Stdout(&stdout)
|
||||
suite.mockCmd.EXPECT().
|
||||
@@ -60,9 +78,9 @@ func (suite *LintTestSuite) TestPrepareAndExecute() {
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
err := l.Prepare(cfg)
|
||||
err := l.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
l.Execute(cfg)
|
||||
l.Execute()
|
||||
}
|
||||
|
||||
func (suite *LintTestSuite) TestPrepareRequiresChart() {
|
||||
@@ -70,25 +88,22 @@ func (suite *LintTestSuite) TestPrepareRequiresChart() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
cfg := Config{}
|
||||
l := Lint{}
|
||||
|
||||
err := l.Prepare(cfg)
|
||||
l := NewLint(env.Config{})
|
||||
err := l.Prepare()
|
||||
suite.EqualError(err, "chart is required", "Chart should be mandatory")
|
||||
}
|
||||
|
||||
func (suite *LintTestSuite) TestPrepareWithLintFlags() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
cfg := Config{
|
||||
cfg := env.Config{
|
||||
Chart: "./uk/top_40",
|
||||
Values: "width=5",
|
||||
StringValues: "version=2.0",
|
||||
ValuesFiles: []string{"/usr/local/underrides", "/usr/local/overrides"},
|
||||
LintStrictly: true,
|
||||
}
|
||||
|
||||
l := Lint{
|
||||
Chart: "./uk/top_40",
|
||||
}
|
||||
l := NewLint(cfg)
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
@@ -97,6 +112,7 @@ func (suite *LintTestSuite) TestPrepareWithLintFlags() {
|
||||
"--set-string", "version=2.0",
|
||||
"--values", "/usr/local/underrides",
|
||||
"--values", "/usr/local/overrides",
|
||||
"--strict",
|
||||
"./uk/top_40"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
@@ -104,66 +120,8 @@ func (suite *LintTestSuite) TestPrepareWithLintFlags() {
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().String().AnyTimes()
|
||||
|
||||
err := l.Prepare(cfg)
|
||||
err := l.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
}
|
||||
|
||||
func (suite *LintTestSuite) TestPrepareWithDebugFlag() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
stderr := strings.Builder{}
|
||||
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
l := Lint{
|
||||
Chart: "./scotland/top_40",
|
||||
}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.mockCmd.EXPECT().
|
||||
String().
|
||||
Return(fmt.Sprintf("%s %s", path, strings.Join(args, " ")))
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any())
|
||||
suite.mockCmd.EXPECT().Stderr(&stderr)
|
||||
|
||||
err := l.Prepare(cfg)
|
||||
suite.Require().Nil(err)
|
||||
|
||||
want := fmt.Sprintf("Generated command: '%s --debug lint ./scotland/top_40'\n", helmBin)
|
||||
suite.Equal(want, stderr.String())
|
||||
}
|
||||
|
||||
func (suite *LintTestSuite) TestPrepareWithNamespaceFlag() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
cfg := Config{
|
||||
Namespace: "table-service",
|
||||
}
|
||||
|
||||
l := Lint{
|
||||
Chart: "./wales/top_40",
|
||||
}
|
||||
|
||||
actual := []string{}
|
||||
command = func(path string, args ...string) cmd {
|
||||
actual = args
|
||||
return suite.mockCmd
|
||||
}
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
err := l.Prepare(cfg)
|
||||
suite.Require().Nil(err)
|
||||
|
||||
expected := []string{"--namespace", "table-service", "lint", "./wales/top_40"}
|
||||
suite.Equal(expected, actual)
|
||||
}
|
||||
|
||||
77
internal/run/repocerts.go
Normal file
77
internal/run/repocerts.go
Normal file
@@ -0,0 +1,77 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"io/ioutil"
|
||||
)
|
||||
|
||||
type repoCerts struct {
|
||||
*config
|
||||
cert string
|
||||
certFilename string
|
||||
caCert string
|
||||
caCertFilename string
|
||||
}
|
||||
|
||||
func newRepoCerts(cfg env.Config) *repoCerts {
|
||||
return &repoCerts{
|
||||
config: newConfig(cfg),
|
||||
cert: cfg.RepoCertificate,
|
||||
caCert: cfg.RepoCACertificate,
|
||||
}
|
||||
}
|
||||
|
||||
func (rc *repoCerts) write() error {
|
||||
if rc.cert != "" {
|
||||
file, err := ioutil.TempFile("", "repo********.cert")
|
||||
defer file.Close()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create certificate file: %w", err)
|
||||
}
|
||||
rc.certFilename = file.Name()
|
||||
rawCert, err := base64.StdEncoding.DecodeString(rc.cert)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to base64-decode certificate string: %w", err)
|
||||
}
|
||||
if rc.debug {
|
||||
fmt.Fprintf(rc.stderr, "writing repo certificate to %s\n", rc.certFilename)
|
||||
}
|
||||
if _, err := file.Write(rawCert); err != nil {
|
||||
return fmt.Errorf("failed to write certificate file: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
if rc.caCert != "" {
|
||||
file, err := ioutil.TempFile("", "repo********.ca.cert")
|
||||
defer file.Close()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create CA certificate file: %w", err)
|
||||
}
|
||||
rc.caCertFilename = file.Name()
|
||||
rawCert, err := base64.StdEncoding.DecodeString(rc.caCert)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to base64-decode CA certificate string: %w", err)
|
||||
}
|
||||
if rc.debug {
|
||||
fmt.Fprintf(rc.stderr, "writing repo ca certificate to %s\n", rc.caCertFilename)
|
||||
}
|
||||
if _, err := file.Write(rawCert); err != nil {
|
||||
return fmt.Errorf("failed to write CA certificate file: %w", err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (rc *repoCerts) flags() []string {
|
||||
flags := make([]string, 0)
|
||||
if rc.certFilename != "" {
|
||||
flags = append(flags, "--cert-file", rc.certFilename)
|
||||
}
|
||||
if rc.caCertFilename != "" {
|
||||
flags = append(flags, "--ca-file", rc.caCertFilename)
|
||||
}
|
||||
|
||||
return flags
|
||||
}
|
||||
80
internal/run/repocerts_test.go
Normal file
80
internal/run/repocerts_test.go
Normal file
@@ -0,0 +1,80 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type RepoCertsTestSuite struct {
|
||||
suite.Suite
|
||||
}
|
||||
|
||||
func TestRepoCertsTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(RepoCertsTestSuite))
|
||||
}
|
||||
|
||||
func (suite *RepoCertsTestSuite) TestNewRepoCerts() {
|
||||
cfg := env.Config{
|
||||
RepoCertificate: "bGljZW5zZWQgYnkgdGhlIFN0YXRlIG9mIE9yZWdvbiB0byBwZXJmb3JtIHJlcG9zc2Vzc2lvbnM=",
|
||||
RepoCACertificate: "T3JlZ29uIFN0YXRlIExpY2Vuc3VyZSBib2FyZA==",
|
||||
}
|
||||
rc := newRepoCerts(cfg)
|
||||
suite.Require().NotNil(rc)
|
||||
suite.Equal("bGljZW5zZWQgYnkgdGhlIFN0YXRlIG9mIE9yZWdvbiB0byBwZXJmb3JtIHJlcG9zc2Vzc2lvbnM=", rc.cert)
|
||||
suite.Equal("T3JlZ29uIFN0YXRlIExpY2Vuc3VyZSBib2FyZA==", rc.caCert)
|
||||
}
|
||||
|
||||
func (suite *RepoCertsTestSuite) TestWrite() {
|
||||
cfg := env.Config{
|
||||
RepoCertificate: "bGljZW5zZWQgYnkgdGhlIFN0YXRlIG9mIE9yZWdvbiB0byBwZXJmb3JtIHJlcG9zc2Vzc2lvbnM=",
|
||||
RepoCACertificate: "T3JlZ29uIFN0YXRlIExpY2Vuc3VyZSBib2FyZA==",
|
||||
}
|
||||
rc := newRepoCerts(cfg)
|
||||
suite.Require().NotNil(rc)
|
||||
|
||||
suite.NoError(rc.write())
|
||||
defer os.Remove(rc.certFilename)
|
||||
defer os.Remove(rc.caCertFilename)
|
||||
suite.NotEqual("", rc.certFilename)
|
||||
suite.NotEqual("", rc.caCertFilename)
|
||||
|
||||
cert, err := ioutil.ReadFile(rc.certFilename)
|
||||
suite.Require().NoError(err)
|
||||
caCert, err := ioutil.ReadFile(rc.caCertFilename)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("licensed by the State of Oregon to perform repossessions", string(cert))
|
||||
suite.Equal("Oregon State Licensure board", string(caCert))
|
||||
}
|
||||
|
||||
func (suite *RepoCertsTestSuite) TestFlags() {
|
||||
rc := newRepoCerts(env.Config{})
|
||||
suite.Equal([]string{}, rc.flags())
|
||||
rc.certFilename = "hurgityburgity"
|
||||
suite.Equal([]string{"--cert-file", "hurgityburgity"}, rc.flags())
|
||||
rc.caCertFilename = "honglydongly"
|
||||
suite.Equal([]string{"--cert-file", "hurgityburgity", "--ca-file", "honglydongly"}, rc.flags())
|
||||
}
|
||||
|
||||
func (suite *RepoCertsTestSuite) TestDebug() {
|
||||
stderr := strings.Builder{}
|
||||
cfg := env.Config{
|
||||
RepoCertificate: "bGljZW5zZWQgYnkgdGhlIFN0YXRlIG9mIE9yZWdvbiB0byBwZXJmb3JtIHJlcG9zc2Vzc2lvbnM=",
|
||||
RepoCACertificate: "T3JlZ29uIFN0YXRlIExpY2Vuc3VyZSBib2FyZA==",
|
||||
Stderr: &stderr,
|
||||
Debug: true,
|
||||
}
|
||||
rc := newRepoCerts(cfg)
|
||||
suite.Require().NotNil(rc)
|
||||
|
||||
suite.NoError(rc.write())
|
||||
defer os.Remove(rc.certFilename)
|
||||
defer os.Remove(rc.caCertFilename)
|
||||
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("writing repo certificate to %s", rc.certFilename))
|
||||
suite.Contains(stderr.String(), fmt.Sprintf("writing repo ca certificate to %s", rc.caCertFilename))
|
||||
}
|
||||
@@ -2,49 +2,57 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
// Uninstall is an execution step that calls `helm uninstall` when executed.
|
||||
type Uninstall struct {
|
||||
Release string
|
||||
DryRun bool
|
||||
*config
|
||||
release string
|
||||
dryRun bool
|
||||
keepHistory bool
|
||||
cmd cmd
|
||||
}
|
||||
|
||||
// NewUninstall creates an Uninstall using fields from the given Config. No validation is performed at this time.
|
||||
func NewUninstall(cfg env.Config) *Uninstall {
|
||||
return &Uninstall{
|
||||
config: newConfig(cfg),
|
||||
release: cfg.Release,
|
||||
dryRun: cfg.DryRun,
|
||||
keepHistory: cfg.KeepHistory,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm uninstall` command.
|
||||
func (u *Uninstall) Execute(_ Config) error {
|
||||
func (u *Uninstall) Execute() error {
|
||||
return u.cmd.Run()
|
||||
}
|
||||
|
||||
// Prepare gets the Uninstall ready to execute.
|
||||
func (u *Uninstall) Prepare(cfg Config) error {
|
||||
if u.Release == "" {
|
||||
func (u *Uninstall) Prepare() error {
|
||||
if u.release == "" {
|
||||
return fmt.Errorf("release is required")
|
||||
}
|
||||
|
||||
args := make([]string, 0)
|
||||
|
||||
if cfg.Namespace != "" {
|
||||
args = append(args, "--namespace", cfg.Namespace)
|
||||
}
|
||||
if cfg.Debug {
|
||||
args = append(args, "--debug")
|
||||
}
|
||||
|
||||
args := u.globalFlags()
|
||||
args = append(args, "uninstall")
|
||||
|
||||
if u.DryRun {
|
||||
if u.dryRun {
|
||||
args = append(args, "--dry-run")
|
||||
}
|
||||
if u.keepHistory {
|
||||
args = append(args, "--keep-history")
|
||||
}
|
||||
|
||||
args = append(args, u.Release)
|
||||
args = append(args, u.release)
|
||||
|
||||
u.cmd = command(helmBin, args...)
|
||||
u.cmd.Stdout(cfg.Stdout)
|
||||
u.cmd.Stderr(cfg.Stderr)
|
||||
u.cmd.Stdout(u.stdout)
|
||||
u.cmd.Stderr(u.stderr)
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", u.cmd.String())
|
||||
if u.debug {
|
||||
fmt.Fprintf(u.stderr, "Generated command: '%s'\n", u.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
@@ -35,12 +34,26 @@ func TestUninstallTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(UninstallTestSuite))
|
||||
}
|
||||
|
||||
func (suite *UninstallTestSuite) TestNewUninstall() {
|
||||
cfg := env.Config{
|
||||
DryRun: true,
|
||||
Release: "jetta_id_love_to_change_the_world",
|
||||
KeepHistory: true,
|
||||
}
|
||||
u := NewUninstall(cfg)
|
||||
suite.Equal("jetta_id_love_to_change_the_world", u.release)
|
||||
suite.Equal(true, u.dryRun)
|
||||
suite.Equal(true, u.keepHistory)
|
||||
suite.NotNil(u.config)
|
||||
}
|
||||
|
||||
func (suite *UninstallTestSuite) TestPrepareAndExecute() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
u := Uninstall{
|
||||
cfg := env.Config{
|
||||
Release: "zayde_wølf_king",
|
||||
}
|
||||
u := NewUninstall(cfg)
|
||||
|
||||
actual := []string{}
|
||||
command = func(path string, args ...string) cmd {
|
||||
@@ -58,77 +71,49 @@ func (suite *UninstallTestSuite) TestPrepareAndExecute() {
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
cfg := Config{}
|
||||
suite.NoError(u.Prepare(cfg))
|
||||
suite.NoError(u.Prepare())
|
||||
expected := []string{"uninstall", "zayde_wølf_king"}
|
||||
suite.Equal(expected, actual)
|
||||
|
||||
u.Execute(cfg)
|
||||
u.Execute()
|
||||
}
|
||||
|
||||
func (suite *UninstallTestSuite) TestPrepareDryRunFlag() {
|
||||
u := Uninstall{
|
||||
cfg := env.Config{
|
||||
Release: "firefox_ak_wildfire",
|
||||
DryRun: true,
|
||||
}
|
||||
cfg := Config{}
|
||||
u := NewUninstall(cfg)
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
suite.NoError(u.Prepare(cfg))
|
||||
suite.NoError(u.Prepare())
|
||||
expected := []string{"uninstall", "--dry-run", "firefox_ak_wildfire"}
|
||||
suite.Equal(expected, suite.actualArgs)
|
||||
}
|
||||
|
||||
func (suite *UninstallTestSuite) TestPrepareNamespaceFlag() {
|
||||
u := Uninstall{
|
||||
Release: "carly_simon_run_away_with_me",
|
||||
}
|
||||
cfg := Config{
|
||||
Namespace: "emotion",
|
||||
func (suite *UninstallTestSuite) TestPrepareKeepHistoryFlag() {
|
||||
cfg := env.Config{
|
||||
Release: "perturbator_sentient",
|
||||
KeepHistory: true,
|
||||
}
|
||||
u := NewUninstall(cfg)
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
suite.NoError(u.Prepare(cfg))
|
||||
expected := []string{"--namespace", "emotion", "uninstall", "carly_simon_run_away_with_me"}
|
||||
suite.NoError(u.Prepare())
|
||||
expected := []string{"uninstall", "--keep-history", "perturbator_sentient"}
|
||||
suite.Equal(expected, suite.actualArgs)
|
||||
}
|
||||
|
||||
func (suite *UninstallTestSuite) TestPrepareDebugFlag() {
|
||||
u := Uninstall{
|
||||
Release: "just_a_band_huff_and_puff",
|
||||
}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.mockCmd.EXPECT().
|
||||
String().
|
||||
Return(fmt.Sprintf("%s %s", path, strings.Join(args, " ")))
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(&stderr).AnyTimes()
|
||||
|
||||
suite.NoError(u.Prepare(cfg))
|
||||
suite.Equal(fmt.Sprintf("Generated command: '%s --debug "+
|
||||
"uninstall just_a_band_huff_and_puff'\n", helmBin), stderr.String())
|
||||
}
|
||||
|
||||
func (suite *UninstallTestSuite) TestPrepareRequiresRelease() {
|
||||
// These aren't really expected, but allowing them gives clearer test-failure messages
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
u := Uninstall{}
|
||||
err := u.Prepare(Config{})
|
||||
u := NewUninstall(env.Config{})
|
||||
err := u.Prepare()
|
||||
suite.EqualError(err, "release is required", "Uninstall.Release should be mandatory")
|
||||
}
|
||||
|
||||
@@ -2,83 +2,127 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
)
|
||||
|
||||
// Upgrade is an execution step that calls `helm upgrade` when executed.
|
||||
type Upgrade struct {
|
||||
Chart string
|
||||
Release string
|
||||
*config
|
||||
chart string
|
||||
release string
|
||||
|
||||
ChartVersion string
|
||||
DryRun bool
|
||||
Wait bool
|
||||
ReuseValues bool
|
||||
Timeout string
|
||||
Force bool
|
||||
chartVersion string
|
||||
dryRun bool
|
||||
wait bool
|
||||
values string
|
||||
stringValues string
|
||||
valuesFiles []string
|
||||
reuseValues bool
|
||||
timeout string
|
||||
force bool
|
||||
atomic bool
|
||||
cleanupOnFail bool
|
||||
historyMax int
|
||||
certs *repoCerts
|
||||
createNamespace bool
|
||||
skipCrds bool
|
||||
|
||||
cmd cmd
|
||||
}
|
||||
|
||||
// NewUpgrade creates an Upgrade using fields from the given Config. No validation is performed at this time.
|
||||
func NewUpgrade(cfg env.Config) *Upgrade {
|
||||
return &Upgrade{
|
||||
config: newConfig(cfg),
|
||||
chart: cfg.Chart,
|
||||
release: cfg.Release,
|
||||
chartVersion: cfg.ChartVersion,
|
||||
dryRun: cfg.DryRun,
|
||||
wait: cfg.Wait,
|
||||
values: cfg.Values,
|
||||
stringValues: cfg.StringValues,
|
||||
valuesFiles: cfg.ValuesFiles,
|
||||
reuseValues: cfg.ReuseValues,
|
||||
timeout: cfg.Timeout,
|
||||
force: cfg.Force,
|
||||
atomic: cfg.AtomicUpgrade,
|
||||
cleanupOnFail: cfg.CleanupOnFail,
|
||||
historyMax: cfg.HistoryMax,
|
||||
certs: newRepoCerts(cfg),
|
||||
createNamespace: cfg.CreateNamespace,
|
||||
skipCrds: cfg.SkipCrds,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute executes the `helm upgrade` command.
|
||||
func (u *Upgrade) Execute(_ Config) error {
|
||||
func (u *Upgrade) Execute() error {
|
||||
return u.cmd.Run()
|
||||
}
|
||||
|
||||
// Prepare gets the Upgrade ready to execute.
|
||||
func (u *Upgrade) Prepare(cfg Config) error {
|
||||
if u.Chart == "" {
|
||||
func (u *Upgrade) Prepare() error {
|
||||
if u.chart == "" {
|
||||
return fmt.Errorf("chart is required")
|
||||
}
|
||||
if u.Release == "" {
|
||||
if u.release == "" {
|
||||
return fmt.Errorf("release is required")
|
||||
}
|
||||
|
||||
args := make([]string, 0)
|
||||
|
||||
if cfg.Namespace != "" {
|
||||
args = append(args, "--namespace", cfg.Namespace)
|
||||
}
|
||||
if cfg.Debug {
|
||||
args = append(args, "--debug")
|
||||
}
|
||||
|
||||
args := u.globalFlags()
|
||||
args = append(args, "upgrade", "--install")
|
||||
|
||||
if u.ChartVersion != "" {
|
||||
args = append(args, "--version", u.ChartVersion)
|
||||
if u.chartVersion != "" {
|
||||
args = append(args, "--version", u.chartVersion)
|
||||
}
|
||||
if u.DryRun {
|
||||
if u.dryRun {
|
||||
args = append(args, "--dry-run")
|
||||
}
|
||||
if u.Wait {
|
||||
if u.wait {
|
||||
args = append(args, "--wait")
|
||||
}
|
||||
if u.ReuseValues {
|
||||
if u.reuseValues {
|
||||
args = append(args, "--reuse-values")
|
||||
}
|
||||
if u.Timeout != "" {
|
||||
args = append(args, "--timeout", u.Timeout)
|
||||
if u.timeout != "" {
|
||||
args = append(args, "--timeout", u.timeout)
|
||||
}
|
||||
if u.Force {
|
||||
if u.force {
|
||||
args = append(args, "--force")
|
||||
}
|
||||
if cfg.Values != "" {
|
||||
args = append(args, "--set", cfg.Values)
|
||||
if u.atomic {
|
||||
args = append(args, "--atomic")
|
||||
}
|
||||
if cfg.StringValues != "" {
|
||||
args = append(args, "--set-string", cfg.StringValues)
|
||||
if u.cleanupOnFail {
|
||||
args = append(args, "--cleanup-on-fail")
|
||||
}
|
||||
for _, vFile := range cfg.ValuesFiles {
|
||||
if u.values != "" {
|
||||
args = append(args, "--set", u.values)
|
||||
}
|
||||
if u.stringValues != "" {
|
||||
args = append(args, "--set-string", u.stringValues)
|
||||
}
|
||||
if u.createNamespace {
|
||||
args = append(args, "--create-namespace")
|
||||
}
|
||||
if u.skipCrds {
|
||||
args = append(args, "--skip-crds")
|
||||
}
|
||||
for _, vFile := range u.valuesFiles {
|
||||
args = append(args, "--values", vFile)
|
||||
}
|
||||
args = append(args, u.certs.flags()...)
|
||||
|
||||
args = append(args, u.Release, u.Chart)
|
||||
// always set --history-max since it defaults to non-zero value
|
||||
args = append(args, fmt.Sprintf("--history-max=%d", u.historyMax))
|
||||
|
||||
args = append(args, u.release, u.chart)
|
||||
u.cmd = command(helmBin, args...)
|
||||
u.cmd.Stdout(cfg.Stdout)
|
||||
u.cmd.Stderr(cfg.Stderr)
|
||||
u.cmd.Stdout(u.stdout)
|
||||
u.cmd.Stderr(u.stderr)
|
||||
|
||||
if cfg.Debug {
|
||||
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", u.cmd.String())
|
||||
if u.debug {
|
||||
fmt.Fprintf(u.stderr, "Generated command: '%s'\n", u.cmd.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
@@ -2,10 +2,12 @@ package run
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/golang/mock/gomock"
|
||||
"github.com/pelotech/drone-helm3/internal/env"
|
||||
"github.com/stretchr/testify/suite"
|
||||
)
|
||||
|
||||
type UpgradeTestSuite struct {
|
||||
@@ -31,17 +33,53 @@ func TestUpgradeTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(UpgradeTestSuite))
|
||||
}
|
||||
|
||||
func (suite *UpgradeTestSuite) TestNewUpgrade() {
|
||||
cfg := env.NewTestConfig(suite.T())
|
||||
cfg.ChartVersion = "seventeen"
|
||||
cfg.DryRun = true
|
||||
cfg.Wait = true
|
||||
cfg.Values = "steadfastness,forthrightness"
|
||||
cfg.StringValues = "tensile_strength,flexibility"
|
||||
cfg.ValuesFiles = []string{"/root/price_inventory.yml"}
|
||||
cfg.ReuseValues = true
|
||||
cfg.Timeout = "go sit in the corner"
|
||||
cfg.Chart = "billboard_top_100"
|
||||
cfg.Release = "post_malone_circles"
|
||||
cfg.Force = true
|
||||
cfg.AtomicUpgrade = true
|
||||
cfg.CleanupOnFail = true
|
||||
|
||||
up := NewUpgrade(*cfg)
|
||||
|
||||
suite.Equal(cfg.Chart, up.chart)
|
||||
suite.Equal(cfg.Release, up.release)
|
||||
suite.Equal(cfg.ChartVersion, up.chartVersion)
|
||||
suite.Equal(true, up.dryRun)
|
||||
suite.Equal(cfg.Wait, up.wait)
|
||||
suite.Equal("steadfastness,forthrightness", up.values)
|
||||
suite.Equal("tensile_strength,flexibility", up.stringValues)
|
||||
suite.Equal([]string{"/root/price_inventory.yml"}, up.valuesFiles)
|
||||
suite.Equal(cfg.ReuseValues, up.reuseValues)
|
||||
suite.Equal(cfg.Timeout, up.timeout)
|
||||
suite.Equal(cfg.Force, up.force)
|
||||
suite.Equal(true, up.atomic)
|
||||
suite.Equal(true, up.cleanupOnFail)
|
||||
suite.NotNil(up.config)
|
||||
suite.NotNil(up.certs)
|
||||
}
|
||||
|
||||
func (suite *UpgradeTestSuite) TestPrepareAndExecute() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
u := Upgrade{
|
||||
Chart: "at40",
|
||||
Release: "jonas_brothers_only_human",
|
||||
}
|
||||
cfg := env.NewTestConfig(suite.T())
|
||||
cfg.Chart = "at40"
|
||||
cfg.Release = "jonas_brothers_only_human"
|
||||
|
||||
u := NewUpgrade(*cfg)
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
suite.Equal([]string{"upgrade", "--install", "jonas_brothers_only_human", "at40"}, args)
|
||||
suite.Equal([]string{"upgrade", "--install", "--history-max=10", "jonas_brothers_only_human", "at40"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
@@ -54,23 +92,24 @@ func (suite *UpgradeTestSuite) TestPrepareAndExecute() {
|
||||
Run().
|
||||
Times(1)
|
||||
|
||||
cfg := Config{}
|
||||
err := u.Prepare(cfg)
|
||||
err := u.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
u.Execute(cfg)
|
||||
u.Execute()
|
||||
}
|
||||
|
||||
func (suite *UpgradeTestSuite) TestPrepareNamespaceFlag() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
u := Upgrade{
|
||||
Chart: "at40",
|
||||
Release: "shaed_trampoline",
|
||||
}
|
||||
cfg := env.NewTestConfig(suite.T())
|
||||
cfg.Namespace = "melt"
|
||||
cfg.Chart = "at40"
|
||||
cfg.Release = "shaed_trampoline"
|
||||
|
||||
u := NewUpgrade(*cfg)
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
suite.Equal([]string{"--namespace", "melt", "upgrade", "--install", "shaed_trampoline", "at40"}, args)
|
||||
suite.Equal([]string{"--namespace", "melt", "upgrade", "--install", "--history-max=10", "shaed_trampoline", "at40"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
@@ -78,32 +117,31 @@ func (suite *UpgradeTestSuite) TestPrepareNamespaceFlag() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any())
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any())
|
||||
|
||||
cfg := Config{
|
||||
Namespace: "melt",
|
||||
}
|
||||
err := u.Prepare(cfg)
|
||||
err := u.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
}
|
||||
|
||||
func (suite *UpgradeTestSuite) TestPrepareWithUpgradeFlags() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
u := Upgrade{
|
||||
Chart: "hot_ac",
|
||||
Release: "maroon_5_memories",
|
||||
ChartVersion: "radio_edit", //-version
|
||||
DryRun: true, //-run
|
||||
Wait: true, //-wait
|
||||
ReuseValues: true, //-values
|
||||
Timeout: "sit_in_the_corner", //-timeout
|
||||
Force: true, //-force
|
||||
}
|
||||
cfg := env.NewTestConfig(suite.T())
|
||||
cfg.Chart = "hot_ac"
|
||||
cfg.Release = "maroon_5_memories"
|
||||
cfg.ChartVersion = "radio_edit"
|
||||
cfg.DryRun = true
|
||||
cfg.Wait = true
|
||||
cfg.Values = "age=35"
|
||||
cfg.StringValues = "height=5ft10in"
|
||||
cfg.ValuesFiles = []string{"/usr/local/stats", "/usr/local/grades"}
|
||||
cfg.ReuseValues = true
|
||||
cfg.Timeout = "sit_in_the_corner"
|
||||
cfg.Force = true
|
||||
cfg.AtomicUpgrade = true
|
||||
cfg.CleanupOnFail = true
|
||||
|
||||
cfg := Config{
|
||||
Values: "age=35",
|
||||
StringValues: "height=5ft10in",
|
||||
ValuesFiles: []string{"/usr/local/stats", "/usr/local/grades"},
|
||||
}
|
||||
u := NewUpgrade(*cfg)
|
||||
// inject a ca cert filename so repoCerts won't create any files that we'd have to clean up
|
||||
u.certs.caCertFilename = "local_ca.cert"
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
@@ -114,10 +152,14 @@ func (suite *UpgradeTestSuite) TestPrepareWithUpgradeFlags() {
|
||||
"--reuse-values",
|
||||
"--timeout", "sit_in_the_corner",
|
||||
"--force",
|
||||
"--atomic",
|
||||
"--cleanup-on-fail",
|
||||
"--set", "age=35",
|
||||
"--set-string", "height=5ft10in",
|
||||
"--values", "/usr/local/stats",
|
||||
"--values", "/usr/local/grades",
|
||||
"--ca-file", "local_ca.cert",
|
||||
"--history-max=10",
|
||||
"maroon_5_memories", "hot_ac"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
@@ -126,7 +168,7 @@ func (suite *UpgradeTestSuite) TestPrepareWithUpgradeFlags() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any())
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any())
|
||||
|
||||
err := u.Prepare(cfg)
|
||||
err := u.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
}
|
||||
|
||||
@@ -135,34 +177,31 @@ func (suite *UpgradeTestSuite) TestRequiresChartAndRelease() {
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||
|
||||
u := Upgrade{
|
||||
Release: "seth_everman_unskippable_cutscene",
|
||||
}
|
||||
u := NewUpgrade(env.Config{})
|
||||
u.release = "seth_everman_unskippable_cutscene"
|
||||
|
||||
err := u.Prepare(Config{})
|
||||
err := u.Prepare()
|
||||
suite.EqualError(err, "chart is required", "Chart should be mandatory")
|
||||
|
||||
u = Upgrade{
|
||||
Chart: "billboard_top_zero",
|
||||
}
|
||||
u.release = ""
|
||||
u.chart = "billboard_top_zero"
|
||||
|
||||
err = u.Prepare(Config{})
|
||||
err = u.Prepare()
|
||||
suite.EqualError(err, "release is required", "Release should be mandatory")
|
||||
}
|
||||
|
||||
func (suite *UpgradeTestSuite) TestPrepareDebugFlag() {
|
||||
u := Upgrade{
|
||||
Chart: "at40",
|
||||
Release: "lewis_capaldi_someone_you_loved",
|
||||
}
|
||||
|
||||
stdout := strings.Builder{}
|
||||
stderr := strings.Builder{}
|
||||
cfg := Config{
|
||||
Debug: true,
|
||||
Stdout: &stdout,
|
||||
Stderr: &stderr,
|
||||
}
|
||||
|
||||
cfg := env.NewTestConfig(suite.T())
|
||||
cfg.Chart = "at40"
|
||||
cfg.Release = "lewis_capaldi_someone_you_loved"
|
||||
cfg.Debug = true
|
||||
cfg.Stdout = &stdout
|
||||
cfg.Stderr = &stderr
|
||||
|
||||
u := NewUpgrade(*cfg)
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.mockCmd.EXPECT().
|
||||
@@ -177,10 +216,36 @@ func (suite *UpgradeTestSuite) TestPrepareDebugFlag() {
|
||||
suite.mockCmd.EXPECT().
|
||||
Stderr(&stderr)
|
||||
|
||||
u.Prepare(cfg)
|
||||
u.Prepare()
|
||||
|
||||
want := fmt.Sprintf("Generated command: '%s --debug upgrade "+
|
||||
"--install lewis_capaldi_someone_you_loved at40'\n", helmBin)
|
||||
want := fmt.Sprintf(
|
||||
"Generated command: '%s --debug upgrade --install --history-max=10 lewis_capaldi_someone_you_loved at40'\n",
|
||||
helmBin,
|
||||
)
|
||||
suite.Equal(want, stderr.String())
|
||||
suite.Equal("", stdout.String())
|
||||
}
|
||||
|
||||
func (suite *UpgradeTestSuite) TestPrepareSkipCrdsFlag() {
|
||||
defer suite.ctrl.Finish()
|
||||
|
||||
cfg := env.NewTestConfig(suite.T())
|
||||
cfg.Chart = "at40"
|
||||
cfg.Release = "cabbages_smell_great"
|
||||
cfg.SkipCrds = true
|
||||
|
||||
u := NewUpgrade(*cfg)
|
||||
|
||||
command = func(path string, args ...string) cmd {
|
||||
suite.Equal(helmBin, path)
|
||||
suite.Equal([]string{"upgrade", "--install", "--skip-crds", "--history-max=10", "cabbages_smell_great", "at40"}, args)
|
||||
|
||||
return suite.mockCmd
|
||||
}
|
||||
|
||||
suite.mockCmd.EXPECT().Stdout(gomock.Any())
|
||||
suite.mockCmd.EXPECT().Stderr(gomock.Any())
|
||||
|
||||
err := u.Prepare()
|
||||
suite.Require().Nil(err)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user