initial commit

Author: Oleksandr_Halichenko

.github/workflows/deploy.yml

@@ -0,0 +1,40 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.idea/.gitignore

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ npm install
+```
+
+### Local Development
+
+```
+$ npm run start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true npm run deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> npm run deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

.idea/modules.xml

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

.idea/qava-docs.iml

@@ -0,0 +1,8 @@
+{
+  "label": "Formatters",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Built-in formatters"
+  }
+}

README.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 1
+---
+
+# @qavajs/format-report-portal
+Formatter that sends result to EPAM ReportPortal
+
+`npm install @qavajs/format-report-portal`
+
+## configuration
+
+add formatter to config.js
+```javascript
+module.exports = {
+    default: {
+        format: [
+            '@qavajs/format-report-portal'
+        ],
+        formatOptions: {
+            rpConfig: {
+                token: 'your token',
+                endpoint: 'https://your-rp-instance/api/v1',
+                description: 'Description',
+                tags: ['Tag'],
+                project: 'your project',
+                launch: 'your launch name'
+            },
+        }
+    }
+}
+```

babel.config.js

@@ -0,0 +1,8 @@
+{
+  "label": "Guides",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "Guides"
+  }
+}

docs/Formatters/_category_.json

@@ -0,0 +1,44 @@
+---
+sidebar_position: 1
+---
+# Memory
+Framework provides the capability to transit variables between step and access them from gherkin definitions
+
+You can use special type {text} to transform string parameter to memory value
+                                         
+```javascript
+Then('{text} value should be 42', async function (value) {
+    expect(await value).to.equal(42);
+})
+```
+or read value directly from memory object
+```javascript
+const memory = require('@qavajs/memory');
+
+When(/^save variable as '(.+)'$/, async function (key) {
+    memory.setValue(key, 42);
+});
+
+Then(/^value '(.+)' should be equal to '(.+)'$/, async function (variable1, variable2) {
+    const val = memory.getValue(variable1);
+    expect(val).to.equal(variable2);
+});
+```
+
+```gherkin
+When save variable as 'variable'
+Then value of '$variable' should be equal to '42'
+```
+
+## Using constants and computed
+
+Lib provides capability to set constant values and computed (values that calculated in the moment of call)
+```javascript
+module.exports = {
+    CONSTANT: 42,
+    computed: function() {
+        return Date.now()
+    }
+};
+
+```

docs/Formatters/report-portal.md

@@ -0,0 +1,57 @@
+---
+sidebar_position: 1
+---
+
+# Page Object
+Framework provides capability to transform string value to corresponding page object via
+{element} type
+```javascript
+When('click {element}', async function(element) {
+    await (await element).click();
+});
+```
+or directly call getElement method from po object that resolves plain-english selector and return webdriverIO element or array of webdriverIO element.
+```javascript
+const { po } = require('@qavajs/po');
+
+When(/^click '(.+)'$/, async function (alias) {
+    const element = await po.getElement(alias);
+    await element.waitForClickable();
+    await element.click();
+});
+```
+
+```gherkin
+When click '#1 of Multiple Component > Child Item'
+```
+
+Framework provides capability to get single element from collection by index (#index of Collection) or inner text (#text in Collection).
+
+## Create page object
+
+Framework provides two methods $ and $$ that allow registering elements and collections.
+An element can be defined in form of webdriverIO selector or as an instance of the component class.
+
+Each not top-level component should have selector element in form of webdriverIO selector.
+```javascript
+const { $, $$ } = require('@qavajs/po');
+
+class MultipleComponent {
+    selector = '.list-components li';
+    ChildItem = $('div');
+}
+
+class SingleComponent {
+    selector = '.container';
+    ChildItem = $('.child-item');
+}
+
+class App {
+    SingleElement = $('.single-element');
+    List = $$('.list li');
+    SingleComponent = $(new SingleComponent());
+    MultipleComponents = $$(new MultipleComponent());
+}
+
+module.exports = new App();
+```

docs/Guides/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Modules",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Built-in modules"
+  }
+}

docs/Guides/memory.md

@@ -0,0 +1,66 @@
+---
+sidebar_position: 1
+---
+
+# @qavajs/template
+Module that allow to define step definitions on Gherkin language.
+
+`npm install @qavajs/template`
+
+```gherkin
+Feature: Templates
+
+  Scenario: I login
+    When I open 'https://your-app.com'
+    And I type 'username' to 'Login Form > Username Input'
+    And I type 'password' to 'Login Form > Password Input'
+    And I click 'Login Form > Login Button'
+```
+
+Then following template can be called from scenario as simple step
+
+```gherkin
+Feature: Auth
+
+  Scenario: Verify that user is able to login
+    When I login
+    Then I expect 'Header' to be visible
+```
+
+Templates also can accept parameters as < param> e.g
+
+```gherkin
+Feature: Templates
+
+  Scenario: I login as <username> with <password> password
+    When I open 'https://your-app.com'
+    And I type '<username>' to 'Login Form > Username Input'
+    And I type '<password>' to 'Login Form > Password Input'
+    And I click 'Login Form > Login Button'
+```
+
+Then following template can be called with actual params
+
+```gherkin
+Feature: Auth
+
+  Scenario: Verify that user is able to login
+    When I login as 'admin' with 'admin' password
+    Then I expect 'Header' to be visible
+```
+
+To use templates their location need to be passed to templates property of config file and library need to be listed
+in require
+```javascript
+module.exports = {
+    default: {
+        require: [
+            'node_modules/@qavajs/steps-config-loader'
+        ],
+        requireModule: [
+            '@qavajs/template'
+        ],
+        templates: ['templates/*.feature']
+    }
+}
+````

docs/Guides/page-object.md

@@ -0,0 +1,8 @@
+{
+  "label": "Steps",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Built-in steps"
+  }
+}