base on CLI tool for linting and testing Helm charts # Chart Testing [](https://opensource.org/licenses/Apache-2.0) [](https://goreportcard.com/report/github.com/helm/chart-testing)  `ct` is the tool for testing Helm charts. It is meant to be used for linting and testing pull requests. It automatically detects charts changed against the target branch. ## Installation ### Prerequisites It is recommended to use the provided Docker image which can be [found on Quay](https://quay.io/repository/helmpack/chart-testing). It comes with all necessary tools installed. * [Helm](http://helm.sh) * [Git](https://git-scm.com) (2.17.0 or later) * [Yamllint](https://github.com/adrienverge/yamllint) * [Yamale](https://github.com/23andMe/Yamale) * [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) ### Binary Distribution Download the release distribution for your OS from the Releases page: https://github.com/helm/chart-testing/releases Unpack the `ct` binary, add it to your PATH, and you are good to go! ### Docker Image A Docker image is available at `quay.io/helmpack/chart-testing` with list of available tags [here](https://quay.io/repository/helmpack/chart-testing?tab=tags). ### Homebrew ```console $ brew install chart-testing ``` ## Usage See documentation for individual commands: * [ct](doc/ct.md) * [ct install](doc/ct_install.md) * [ct lint](doc/ct_lint.md) * [ct lint-and-install](doc/ct_lint-and-install.md) * [ct list-changed](doc/ct_list-changed.md) * [ct version](doc/ct_version.md) For a more extensive how-to guide, please see: * [charts-repo-actions-demo](https://github.com/helm/charts-repo-actions-demo) ## Configuration `ct` is a command-line application. All command-line flags can also be set via environment variables or config file. Environment variables must be prefixed with `CT_`. Underscores must be used instead of hyphens. CLI flags, environment variables, and a config file can be mixed. The following order of precedence applies: 1. CLI flags 1. Environment variables 1. Config file Note that linting requires config file for [yamllint](https://github.com/adrienverge/yamllint) and [yamale](https://github.com/23andMe/Yamale). If not specified, these files are search in the current directory, the `.ct` directory in current directory, `$HOME/.ct`, and `/etc/ct`, in that order. Samples are provided in the [etc](etc) folder. ### Examples The following example show various way of configuring the same thing: #### CLI #### Remote repo With remote repo: ct install --remote upstream --chart-dirs stable,incubator --build-id pr-42 #### Local repo If you have a chart in current directory and ct installed on the host then you can run: ct install --chart-dirs . --charts . With docker it works with: docker run -it --network host --workdir=/data --volume ~/.kube/config:/root/.kube/config:ro --volume $(pwd):/data quay.io/helmpack/chart-testing:v3.7.1 ct install --chart-dirs . --charts . Notice that `workdir` param is important and must be the same as volume mounted. #### Environment Variables export CT_REMOTE=upstream export CT_CHART_DIRS=stable,incubator export CT_BUILD_ID ct install #### Config File `config.yaml`: ```yaml remote: upstream chart-dirs: - stable - incubator build-id: pr-42 ``` #### Config Usage ct install --config config.yaml `ct` supports any format [Viper](https://github.com/spf13/viper) can read, i. e. JSON, TOML, YAML, HCL, and Java properties files. Notice that if no config file is specified, then `ct.yaml` (or any of the supported formats) is loaded from the current directory, `$HOME/.ct`, or `/etc/ct`, in that order, if found. #### Using private chart repositories When adding chart-repos you can specify additional arguments for the `helm repo add` command using `helm-repo-extra-args` on a per-repo basis. You can also specify OCI registries which will be added using the `helm registry login` command, they also support the `helm-repo-extra-args` for authentication. This could for example be used to authenticate a private chart repository. `config.yaml`: ```yaml chart-repos: - incubator=https://incubator.io - basic-auth=https://private.com - ssl-repo=https://self-signed.ca - oci-registry=oci://nice-oci-registry.pt helm-repo-extra-args: - ssl-repo=--ca-file ./my-ca.crt ``` ct install --config config.yaml --helm-repo-extra-args "basic-auth=--username user --password secret" ## Building from Source `ct` is built using Go 1.13 or higher. `build.sh` is used to build and release the tool. It uses [Goreleaser](https://goreleaser.com/) under the covers. Note: on MacOS you will need `GNU Coreutils readlink`. You can install it with: ```console brew install coreutils ``` Then add `gnubin` to your `$PATH`, with: ```console echo 'export PATH="$(brew --prefix coreutils)/libexec/gnubin:$PATH"' >> ~/.bash_profile bash --login ``` To use the build script: ```console $ ./build.sh -h Usage: build.sh <options> Build ct using Goreleaser. -h, --help Display help -d, --debug Display verbose output and run Goreleaser with --debug -r, --release Create a release using Goreleaser. This includes the creation of a GitHub release and building and pushing the Docker image. If this flag is not specified, Goreleaser is run with --snapshot ``` ## Releasing ### Prepare Release Before a release is created, versions have to be updated in the examples. A pull request needs to be created for this, which should be merged right before the release is cut. Here's a previous one for reference: https://github.com/helm/chart-testing/pull/89 ### Create Release The release workflow is [dispatched from github actions](https://github.com/helm/chart-testing/actions) Versions must start with a lower-case `v`, e. g. `v3.7.1`. ## Supported versions The previous MAJOR version will be supported for three months after each new MAJOR release. Within this support window, pull requests for the previous MAJOR version should be made against the previous release branch. For example, if the current MAJOR version is `v2`, the pull request base branch should be `release-v1`. ## Upgrading When upgrading from `< v2.0.0` you will also need to change the usage in your scripts. This is because, while the [v2.0.0](https://github.com/helm/chart-testing/releases/tag/v2.0.0) release has parity with `v1`, it was refactored from a bash library to Go so there are minor syntax differences. Compare [v1 usage](https://github.com/helm/chart-testing/tree/release-v1#usage) with this (`v2`) version's README [usage](#usage) section above. ", Assign "at most 3 tags" to the expected json: {"id":"7921","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"