Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Testkube Doc: refine test doc for content.type #541

Merged
merged 3 commits into from
Jun 9, 2023

Conversation

gberche-orange
Copy link
Contributor

Pull request description

Doc: refine schema for content.type

Extracted from https://github.com/kubeshop/testkube/blob/cca3c13629078891f269f691e1050ae5adb99d5a/docs/docs/test-types/prebuilt-executor.md?plain=1#L60-L65

Checklist (choose whats happened)

  • breaking change! (describe)
  • tested locally
  • tested on cluster
  • added new dependencies
  • updated the docs
  • added a test

Breaking changes

Changes

Fixes

string: String content (e.g. Postman JSON file).
file-uri: content stored on the webserver.
git-file: the file stored in the Git repo in the given path.
git-dir: the entire git repo or git subdirectory (Testkube does a spatial checkout to limit traffic in the case of monorepos).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, we also support git type, it automatically detects file or dirs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, I gave it a try into 12313d9 does it properly captures current behavior ?

Copy link
Contributor Author

@gberche-orange gberche-orange Jun 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, is it intended that the sparse checkout leaves the /data/repo with root of the git repo and not the subdir as new root ?

E.g. with path: micro-depls/00-core-connectivity-k8s/k8s-config/manifests/02-testkube-executors the container currently sees the following

6481e45d62b70b1853b6a89c-kzm8b:~# tree /data/repo/
/data/repo/
└── micro-depls
    └── 00-core-connectivity-k8s
        └── k8s-config
            └── manifests
                └── 02-testkube-executors
                    ├── 02-testkube-sample-tests-kuttl-test-git-repo.yaml
...
                    └── last_rendered_kustomization.yaml

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

internally, we already trreat everything as git. yes, the idea is to support monorepo as well

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks,

BTW, is it intended that the sparse checkout leaves the /data/repo with root of the git repo and not the subdir as new root ?

sorry I had missed the workingDir field which answers my question

                        workingDir:
                          description: if provided we checkout the whole repository
                            and run test from this directory
                          type: string
``

Refine git wording

https://git-scm.com/docs/git-clone
> --depth <depth>
>      Create a shallow clone with a history truncated to the specified number of commits.
https://git-scm.com/docs/git-sparse-checkout
> This command is used to create sparse checkouts, which change the working tree from having all tracked files present to only having a subset of those files
gberche-orange added a commit to orange-cloudfoundry/testkube that referenced this pull request Jun 8, 2023
gberche-orange added a commit to orange-cloudfoundry/testkube that referenced this pull request Jun 8, 2023
@vsukhin vsukhin merged commit b5b6c37 into kubeshop:develop Jun 9, 2023
vsukhin added a commit that referenced this pull request Jul 7, 2023
* feat: cron job template field (#480)

* feat: cron job template field

* fix: add namespace to cron job domain

* fix: remove namespace

* fix typo (#486)

* feat: deprecate args (#475)

* feat: args mode field

* fix: curl command and args

* feat: artillery commands and args

* feat: change artifact support

* fix: add artifacts to curl and artillery

* fix: typo

* feat: postamn command and args

* feat: kubepug args and command

* feat: soapui command and args

* feat: maven args and command

* feat: jmeter command and args

* fix: jemeter args

* feat: cypress command and args

* fix: one more cypress args

* feat: ginkgo command and args

* fix: ginkgo args

* fix: ginkgo vars arg

* feat: k6 command and args

* feat: playwright args and command

* fix: rename k6 arg

* fix bugs (#489)

* fix executors.json (#491)

* rework flow to depploy executors with api (#492)

* update sed (#494)

* Update branch (#496)

update branch

* Update branch (#497)

update develop

* edit script for updating chart versions (#500)

* edit script for updating chart versions

* [testkube-api] minio allow setting minio replicaCount (#502)

* Fix post request in nginx config (#504)

* update post config in nginx

* commit executor image tag to develop (#505)

* added force push for kubeshop bot user

* Update executors.json

* add if to commit executur step

* add if to commit executur step

* added removed line from test run

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* update release branch naming (#509)

* Testkube dev - overwrite branch on test run (#506)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* update chart releaser script

* Fix kubeoperator preupgrade josb for multi-namespace (#507)

Fix kubeoperator preupgrade josb for multi-namespace (#507)

* Set a sensible default for API server HTTP Read buffer size (#513)

Set a sensible default for API server HTTP Read buffer size (#513)

* Update executors.json

* Update executors.json

* convert the var to staring (#514)

* feat: cdevents support (#503)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* ci: add changelog generation (#516)

ci: add changelog generation

* feat: dashboard uri for cd events (#517)

* feat: dashboard uri for cd events

* fix: env var for dashboard uri

* docs: dashboard uri

* Update executors.json

* feat: add option to force disabling telemetry on the UI (#518)

Related to: kubeshop/testkube#3884

* fix: testkube service monitor target port (#515)

* Fix service monitor target port

* feat: zap executor (#511)

* feat: zap executor

* feat: add zap to dev release

* ci: add zap to stage and pre-release

* ci: addressing code review comments

* ci: update tests

* feat: condition ttl (#520)

* Update executors.json

* Update executors.json

* Update executors.json

* add automatic pr creation (#521)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* ci: add condition for checking if executors.json were updated (#523)

ci: add condition for checking if executors.json were updated (#523)

* Update executors.json

* ci: fix client payload for image tag pre-release

* Update executors.json

* Update executors.json

* ci: update branch for tests in stage workflow (#524)

* feat: added webhook to cdevents for test purpose (#525)

* Update executors.json

* fix: new webhook.site to bypass limits

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: add TTL for k8s jobs (#530)

* Update executors.json

* Update executors.json

* Update executors.json

* fix: preupgrade lables

* Revert "fix: preupgrade lables"

This reverts commit 02f6971.

* fix: preupgrade labels (#533)

* Update executors.json

* feat: webhook template and headers (#538)

* Update executors.json

* add cloud migrate env (#540)

* Update executors.json

* Update executors.json

* Update executors.json

* Testkube Doc: refine  test doc for content.type (#541)

* Doc: refine schema for content.type

Extracted from https://github.com/kubeshop/testkube/blob/cca3c13629078891f269f691e1050ae5adb99d5a/docs/docs/test-types/prebuilt-executor.md?plain=1#L60-L65

* Doc: refine schema for content.type

Extracted from https://github.com/kubeshop/testkube/blob/cca3c13629078891f269f691e1050ae5adb99d5a/docs/docs/test-types/prebuilt-executor.md?plain=1#L60-L65

* Doc: refine schema for content.type

Refine git wording

https://git-scm.com/docs/git-clone
> --depth <depth>
>      Create a shallow clone with a history truncated to the specified number of commits.
https://git-scm.com/docs/git-sparse-checkout
> This command is used to create sparse checkouts, which change the working tree from having all tracked files present to only having a subset of those files

* Doc update: preRunScript ignored for container executor (#535)

See https://discord.com/channels/884464549347074049/1088559756714705067/1088571830639542343

* Update executors.json

* fix: template labels

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: testsuite v3 (#380)

* feat: testsuite v3

* fix: remove required steps

* fix: sync testsuite crd

* fix: duration format

* fix: change test suite step definition

* fix: yaml indent

* Update executors.json

* Update executors.json

* fix: minio service labels (#544)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* charts: add warning for global image params (#547)

* fix error with enabled tls (#548)

* testkube-operator: Removed ns from tokenSecret and usernameSecret (#545)

* Update executors.json

* Update executors.json

* feat: update config map for testkube-api (#550)

* update config map for testkube-api to pass custom job-template.yml

* Update executors.json

* Update executors.json

* Update executors.json

* update branch for checking out tests (#552)

* Update executors.json

* add arg to run install beta release to test cli (#554)

* Update executors.json

* feat: post run script field (#555)

* feat: post run script field

* fix: field type

* fix: indent

* Update executors.json

* Update executors.json

* Update executors.json

* feat: update referencing of secrets in minio and TK API (#557)

* update referencing of secrets in minio and TK API

* Update executors.json

* ci: update releaser script (#558)

* Update executors.json

* ci: add release notes generation (#551)

* ci: add flow to deploy to stage on values.yaml update (#560)

* feat: cluster name parameter (#559)

* feat: cluster name parameter

* Update charts/testkube/README.md

Co-authored-by: Lilla Vass <[email protected]>

---------

Co-authored-by: Lilla Vass <[email protected]>

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* remove probes for mongo

* feat: add basic auth (#562)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: probe conditions (#561)

* feat: probe spec

* fix: refactor probe spec crd

* Update executors.json

* Update executors.json

* feat: tracetest executor (#564)

* feat: tracetest executor

* fix: update tag on tracetest executor docker image

* Update executors.json

* fix: resource separation inside conditional loops to avoid templating issue when operator webhook disabled (#565)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* add basic auth for beta env (#566)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Revert "feat: tracetest executor (#564)"

This reverts commit 248b159.

# Conflicts:
#	charts/testkube-api/executors.json

* Revert "feat: probe conditions (#561)"

This reverts commit 1573b66.

---------

Co-authored-by: ypoplavs <[email protected]>
Co-authored-by: Povilas Versockas <[email protected]>
Co-authored-by: kubeshop-bot <[email protected]>
Co-authored-by: ypoplavs <[email protected]>
Co-authored-by: Tomasz Konieczny <[email protected]>
Co-authored-by: Guillaume Berche <[email protected]>
Co-authored-by: Dawid Rusnak <[email protected]>
Co-authored-by: Lilla Vass <[email protected]>
Co-authored-by: Jacek Wysocki <[email protected]>
Co-authored-by: Jesper Axelsen <[email protected]>
Co-authored-by: Carlos <[email protected]>
vsukhin added a commit that referenced this pull request Aug 24, 2023
* feat: dashboard uri for cd events (#517)

* feat: dashboard uri for cd events

* fix: env var for dashboard uri

* docs: dashboard uri

* Update executors.json

* feat: add option to force disabling telemetry on the UI (#518)

Related to: kubeshop/testkube#3884

* fix: testkube service monitor target port (#515)

* Fix service monitor target port

* feat: zap executor (#511)

* feat: zap executor

* feat: add zap to dev release

* ci: add zap to stage and pre-release

* ci: addressing code review comments

* ci: update tests

* feat: condition ttl (#520)

* Update executors.json

* Update executors.json

* Update executors.json

* add automatic pr creation (#521)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* ci: add condition for checking if executors.json were updated (#523)

ci: add condition for checking if executors.json were updated (#523)

* Update executors.json

* ci: fix client payload for image tag pre-release

* Update executors.json

* Update executors.json

* ci: update branch for tests in stage workflow (#524)

* feat: added webhook to cdevents for test purpose (#525)

* Update executors.json

* fix: new webhook.site to bypass limits

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: add TTL for k8s jobs (#530)

* Update executors.json

* Update executors.json

* Update executors.json

* fix: preupgrade lables

* Revert "fix: preupgrade lables"

This reverts commit 02f6971.

* fix: preupgrade labels (#533)

* Update executors.json

* feat: webhook template and headers (#538)

* Update executors.json

* add cloud migrate env (#540)

* Update executors.json

* Update executors.json

* Update executors.json

* Testkube Doc: refine  test doc for content.type (#541)

* Doc: refine schema for content.type

Extracted from https://github.com/kubeshop/testkube/blob/cca3c13629078891f269f691e1050ae5adb99d5a/docs/docs/test-types/prebuilt-executor.md?plain=1#L60-L65

* Doc: refine schema for content.type

Extracted from https://github.com/kubeshop/testkube/blob/cca3c13629078891f269f691e1050ae5adb99d5a/docs/docs/test-types/prebuilt-executor.md?plain=1#L60-L65

* Doc: refine schema for content.type

Refine git wording

https://git-scm.com/docs/git-clone
> --depth <depth>
>      Create a shallow clone with a history truncated to the specified number of commits.
https://git-scm.com/docs/git-sparse-checkout
> This command is used to create sparse checkouts, which change the working tree from having all tracked files present to only having a subset of those files

* Doc update: preRunScript ignored for container executor (#535)

See https://discord.com/channels/884464549347074049/1088559756714705067/1088571830639542343

* Update executors.json

* fix: template labels

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: testsuite v3 (#380)

* feat: testsuite v3

* fix: remove required steps

* fix: sync testsuite crd

* fix: duration format

* fix: change test suite step definition

* fix: yaml indent

* Update executors.json

* Update executors.json

* fix: minio service labels (#544)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* charts: add warning for global image params (#547)

* fix error with enabled tls (#548)

* testkube-operator: Removed ns from tokenSecret and usernameSecret (#545)

* Update executors.json

* Update executors.json

* feat: update config map for testkube-api (#550)

* update config map for testkube-api to pass custom job-template.yml

* Update executors.json

* Update executors.json

* Update executors.json

* update branch for checking out tests (#552)

* Update executors.json

* add arg to run install beta release to test cli (#554)

* Update executors.json

* feat: post run script field (#555)

* feat: post run script field

* fix: field type

* fix: indent

* Update executors.json

* Update executors.json

* Update executors.json

* feat: update referencing of secrets in minio and TK API (#557)

* update referencing of secrets in minio and TK API

* Update executors.json

* ci: update releaser script (#558)

* Update executors.json

* ci: add release notes generation (#551)

* ci: add flow to deploy to stage on values.yaml update (#560)

* feat: cluster name parameter (#559)

* feat: cluster name parameter

* Update charts/testkube/README.md

Co-authored-by: Lilla Vass <[email protected]>

---------

Co-authored-by: Lilla Vass <[email protected]>

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* remove probes for mongo

* feat: add basic auth (#562)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: probe conditions (#561)

* feat: probe spec

* fix: refactor probe spec crd

* Update executors.json

* Update executors.json

* feat: tracetest executor (#564)

* feat: tracetest executor

* fix: update tag on tracetest executor docker image

* Update executors.json

* fix: resource separation inside conditional loops to avoid templating issue when operator webhook disabled (#565)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* add basic auth for beta env (#566)

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* feat: add Helm option to select CRD revision for front-end, use `develop` for dev.testkube.io (#569)

* Update executors.json

* Update executors.json

* fix: revert logic for secrets in minio (#570)

* namespace added on kubectl apply for dashboard-e2e after namespace removed from CRD (#573)

* ci: Update releaser script (#572)

update main chart releaser script

* Update Chart.yaml file

* update chart.yaml files

* fix api secrets logic (#575)

* update release script (#576)

* Update Chart.yaml file

* update Chart.yaml

* Update executors.json

* Update executors.json

* Testkube - dev - CORS allow all methods (#579)

* ci: deploy integration TK for develop cluster (#567)

* deploy integration TK for develop cluster

* Update executors.json

* Update executors.json

* Update executors.json

* feat: remove outdated comment (#580)

* Update executors.json

* Testkube - integration workflows updated (dashboard-e2e-tests for specific namespace) (#583)

* Testkube - integration workflows updated (dashboard-e2e CRD)

* Testkube - integration workflows updated - separate Dashboard E2E Tests step

* Update executors.json

* Update executors.json

* Update chart_releaser.sh

* Update Chart.yaml files

* Update Chart.yaml

* Update executors.json

* Update Chart.yaml files

* feat: add secrets for oauth (#582)

* feat: compress artifacts flag (#586)

* Update executors.json

* Update executors.json

* fix global labels (#587)

* add global labels for .spec.template

* fix: update image for testkube operator pre-upgrade job(#588)

* Update Chart.yaml file

* Update executors.json

* Update Chart.yaml files

* Update Chart.yaml files

* Update executors.json

* Update executors.json

* fix: update releaser script (#591)

* update releaser script

* Update Chart.yaml file

* fix typo

* update Chart.yaml

* update develop branch with chart yaml file

* Update Chart.yaml files

* Update Chart.yaml files

* Update Chart.yaml files

* Update Chart.yaml file

* revert changes (#593) (#594)

* Update Chart.yaml files

* feat: pass helm chart version (#595)

* Update executors.json

* Update Chart.yaml files

* Add lables values section for testkube-operator preUpgrade webhook job (#599)

* Add lables values and annotations section for testkube-operator preUpgrade webhook job

* Update executors.json

* Update Chart.yaml files

* Update executors.json

* Update executors.json

* Update Chart.yaml files

* Update executors.json

* Update executors.json

* Update Chart.yaml files

* move beta cluster to develop (#600)

* Update Chart.yaml files

* Update executors.json

* fix typo

* Update executors.json

* feat: add priority Class (#602)

* add priority Class

* Update Chart.yaml file

* Update executors.json

* Update Chart.yaml files

* ci: remove beta tk (#605)

* Update executors.json

* fix: image registry (#604)

* disable mongo probes which make the deployment fail

* Update Chart.yaml file

* Update Chart.yaml files

* pass nodeSelector for preUpgradeHook (#608)

* feat: test execution crd (#596)

* feat: test execution crd

* fix: remove output

* feat: test suite execution CRD

* fix: generation field

* fix: add enums

* Update Chart.yaml files

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* Update executors.json

* fix: Allow override of REACT_APP_ROOT_ROUTE with proxyPrefix (#614)

* fix: Allow override of REACT_APP_ROOT_ROUTE with proxyPrefix

Signed-off-by: Tim Hobbs <[email protected]>

* feat: Allow extension of oauth2-proxy environment variables with envFrom (#612)

* Allow extension of oauth2-proxy environment variables with envFrom

Signed-off-by: Tim Hobbs <[email protected]>

* Update executors.json

* Update executors.json

* Update executors.json

* ci: disable mongo probes (#616)

* Update executors.json

* Update executors.json

* charts: specify resource requests (#618)

---------

Signed-off-by: Tim Hobbs <[email protected]>
Co-authored-by: kubeshop-bot <[email protected]>
Co-authored-by: Dawid Rusnak <[email protected]>
Co-authored-by: Guillaume Berche <[email protected]>
Co-authored-by: Lilla Vass <[email protected]>
Co-authored-by: ypoplavs <[email protected]>
Co-authored-by: Jacek Wysocki <[email protected]>
Co-authored-by: ypoplavs <[email protected]>
Co-authored-by: Povilas Versockas <[email protected]>
Co-authored-by: Jesper Axelsen <[email protected]>
Co-authored-by: Carlos <[email protected]>
Co-authored-by: Tomasz Konieczny <[email protected]>
Co-authored-by: ypoplavs <[email protected]>
Co-authored-by: michal-jagiello-tmpl <[email protected]>
Co-authored-by: vsukhin <[email protected]>
Co-authored-by: Krzysztof Warunek <[email protected]>
Co-authored-by: Tim Hobbs <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants