Commit 47c65fc7 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

feat: migrate to CI/CD component 

⚠️ requires GitLab 16.6 or later
parent 638c23d1

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ include: 
    file: '/templates/validation.yml'

  - project: 'to-be-continuous/bash'

    ref: '3.3'

    file: 'templates/gitlab-ci-bash.yml'

    file: '/templates/gitlab-ci-bash.yml'

  - project: 'to-be-continuous/semantic-release'

    ref: '3.7'

    file: '/templates/gitlab-ci-semrel.yml'

README.md

+33 −6
Original line number Diff line number Diff line
@@ -4,13 +4,40 @@ This project implements a GitLab CI/CD template to run your automated (API) test 


## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/postman/gitlab-ci-postman@3.3.0

    # 2: set/override component inputs

    inputs:

      # ⚠ this is only an example

      collections: "e2e/*collection.json"

      review-enabled: "true"

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/postman'

    ref: '3.3.0'

    file: '/templates/gitlab-ci-postman.yml'



variables:

  # 2: set/override template variables

  # ⚠ this is only an example

  POSTMAN_COLLECTIONS: "e2e/*collection.json"

  REVIEW_ENABLED: "true"

```



## `postman` job
@@ -19,12 +46,12 @@ This job starts [Postman automated tests](https://www.postman.com/automated-test 


It uses the following variable:



| Name                  | Description                              | Default value     |

| Input / Variable | Description                              | Default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `POSTMAN_IMAGE`       | The Docker image used to run Postman CLI. | `registry.hub.docker.com/postman/newman:latest` |

| `POSTMAN_COLLECTIONS` | The matcher to select Postman collection file(s) to run. | `postman/*collection.json` |

| `POSTMAN_EXTRA_ARGS`  | Newman extra [run options](https://github.com/postmanlabs/newman#command-line-options) (to use global variables, an environment or a data source for e.g.) | _none_ |

| `REVIEW_ENABLED`      | Set to `true` to enable Postman tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled) |

| `image` / `POSTMAN_IMAGE` | The Docker image used to run Postman CLI. | `registry.hub.docker.com/postman/newman:latest` |

| `collections` / `POSTMAN_COLLECTIONS` | The matcher to select Postman collection file(s) to run. | `postman/*collection.json` |

| `extra-args` / `POSTMAN_EXTRA_ARGS` | Newman extra [run options](https://github.com/postmanlabs/newman#command-line-options) (to use global variables, an environment or a data source for e.g.) | _none_ |

| `review-enabled` / `REVIEW_ENABLED` | Set to `true` to enable Postman tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled) |



In addition to a textual report in the console, this job produces the following reports, kept for one day:

bumpversion.sh

+2 −2
Original line number Diff line number Diff line
@@ -27,13 +27,13 @@ if [[ "$curVer" ]]; then 
  log_info "Bump version from \\e[33;1m${curVer}\\e[0m to \\e[33;1m${nextVer}\\e[0m (release type: $relType)..."



  # replace in README

  sed -e "s/ref: '$curVer'/ref: '$nextVer'/" README.md > README.md.next

  sed -e "s/ref: *'$curVer'/ref: '$nextVer'/" -e "s/ref: *\"$curVer\”/ref: \”$nextVer\”/" -e "s/component: *\(.*\)@$curVer/component: \1@$nextVer/" README.md > README.md.next

  mv -f README.md.next README.md



  # replace in template and variants

  for tmpl in templates/*.yml

  do

    sed -e "s/\"$curVer\"/\"$nextVer\"/" "$tmpl" > "$tmpl.next"

    sed -e "s/command: *\[\"--service\", \"\(.*\)\", \"$curVer\"\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"

    mv -f "$tmpl.next" "$tmpl"

  done

else

kicker.json

+2 −0
Original line number Diff line number Diff line
@@ -3,6 +3,8 @@ 
  "description": "Run your automated (API) tests with [Postman](https://www.postman.com/automated-testing)",

  "template_path": "templates/gitlab-ci-postman.yml",

  "kind": "acceptance",

  "prefix": "postman",

  "is_component": true,

  "variables": [

    {

      "name": "POSTMAN_IMAGE",

logo.png

+4.44 KiB (14.2 KiB)
Loading image diff...