@restqa/restqkube v0.0.1

RestQkube

An Awesome Cucumber library providing ready to use steps to test the state of your Kubernetes Cluster

This is still at POC stage it currently manage checks on namespaces only... Give us a start if you feel that you want more features ⭐️

What is RestQkube ?

RestQkube is a part of the RestQA ecosystem. In order to add regression test to your Kubernetes cluster through automation, RestQkube is proving an awesome bootstrap for you to kick in within a few minute. Based on cucumber-js, the library expand the number of defined step on one of your current automation project based on cucumber-js.

Requirements

• Node.js >= 12
• Cucumber >= 6.0.5

Installation

Using npm:

npm install @restqa/restqkube cucumber

Using yarn:

yarn add @restqa/restqkube cucumber

Then you will need to create or update your world.js file:

//support/world.js

const {
  After, AfterAll, Before, BeforeAll,
  Given, When, Then,
  defineParameterType,
  setWorldConstructor
} = require('cucumber')

const RestQkube = require('@restqa/restqkube')

const options = {
  name: 'local',
  url: 'http://example.com',
  kube: {
    path: '~/.kube/config'
  }
}

const rQkube = new RestQkube(config)

rQkube.setParameterType(defineParameterType)
rQkube.setSteps({ Given, When, Then })
rQkube.setHooks({ Before, BeforeAll, After, AfterAll })

setWorldConstructor(rQkube.getWorld())

Run your Spec

./node_modules/.bin/cucumber-js

Configuration

In order to run the test you will need to pass an option object to the RestQkube instance

const config = {
  name: 'local',
  kube: {
    path: '~/.kube/config'
  },
  data: {
    channel: 'google-sheet',
    config: {
      id: process.env.GOOGLE_SHEET_ID,
      apikey: process.env.GOOGLE_SHEET_APIKEY
    },
    startSymbol: '{[',
    endSymbol: ']}'
  },
  secrets: {
    'api-key': 'xxx-yyy-zzz'
  },
}

Options

Working with external datasets

In order to decouple your datasets from your scenarios, RestQapi is leveraging the RestQdata library. RestQdata is allowing you to connect RestQapi with an external data source such as :

• Confluence (Your confluence instance should be accessible from restqa run environment)
• Google sheets
• Csv (file need to be hosted next to your .feature file

Feel free to look at the restqdata options : https://github.com/restqa/restqdata

Then once your dataset is connected you will need to start using them in your test scenario.

Example:

The sheet's name is cluster and contains the following information

Then to use the frontend information into the scenario you will just need have the following steps

Then I should see the namespace "{{ cluster.2.namespace }}"

As you can see we used {{ cluster.2.namespace }} to identify the word frontend. The concept is simple, to identify a specific information use the patter {{resource.row.colum}}

More specifically:

• Resource is the name of your sheet
• row is the number of the row
• column is the column name

Working with secrets

Secret are private data that might be required by your api to response properly. In order to have your secret extracted from you scenario you can add them in the options Then you can use it exactly like any other dataset:

// world.js

const options = {
  name: 'local',
  kube: {
    path: '~/.kube/config'
  },
  secrets: {
    'label-key': 'foo=bar'
  }
}

Then inside your scenario :

Then I filter the label "{{ label-key }}"

Example

This repository comes with few examples, in order to run them, invoke the following script:

npm run start:example

Enjoy!

License

Apache 2.0 License