prod

Automation Framework

APPLICATION: framework.js

AUTHOR(S): Armond Sarkisian

MAINTAINER(S): Armond Sarkisian

EMAIL: [email protected]

GIT BRANCHES: main, dev

DESCRIPTION: The back-bone for the automation. This is where all the back-end calls for PyTest and Cypress are stored. This is for Cypress

SPECIFICATIONS:

• Test Framework: Cypress 11.1.0+
• Language: NodeJS 16.13.1+

REQUIREMENTS:

• Cypress - Cypress Client
• GIT - GIT
• Docker - Docker

WORKFLOW:

1. Clone the framework and navigate into the framework directory:

$ git clone ?        # clone project
$ cd framework       # access repo root

2. Open your favourite IDE (i.e., Visual Studio Code) and open the project inside the ./framework.js folder

3. Create your branch and start updating the changes

$ git checkout -b 123-branch-name-goes-here         # create a new development branch

4. Navigate into ./framework.js

5. Perform the necessary implementation

6. Run the following commands:

$ yarn pr:prepare
$ yarn doc:prepare

7. Navigate into the Github project folder: https://github.???????/issues/new/choose

8. Create a new release

9. Be sure to follow the steps, update the version, verify the formatting and create a new pull request

10. Ensure you complete the checklist for the PULL REQUEST

11. Once all is done and merged, be sure to update the remote repository:

$ yarn npm:publish

ARTIFACTORY INSTRUCTIONS:

To get artifactory working, you will need to point to the following:

HELPFUL SOFTWARE/EXTENSIONS/PLUGINS:

The following applications/plugins can further aid you in getting the job done effectively and quickly. I especially recommend VIM if you love keyboard shortcuts.

| PLUGIN | README | | ------------------------- | --------------------------------------------------------------------------------------------------- | | VIM | [https://www.vim.org/] | | TMUX | [https://github.com/tmux/tmux/wiki] | | Vundle Plugin | [https://github.com/VundleVim/Vundle.vim] | | Firebug Plugin | [https://blog.getfirebug.com/] | | Firepath Plugin | [https://firepath.en.downloadastro.com/] | | Omnibug Plugin | [https://chrome.google.com/webstore/detail/omnibug/bknpehncffejahipecakbfkomebjmokl?hl=en] | | JSON Viewer Plugin | [https://chrome.google.com/webstore/detail/json-viewer/gbmdgpbipfallnflgajpaliibnhdgobh?hl=en-US] | | JSON/YAML Toggle Plugin | [https://chrome.google.com/webstore/detail/json-yaml-toggle/dphedhpnbojdegjcokghhfploeobobbc?hl=en] | | iTerm2 Terminal (for Mac) | [https://www.iterm2.com/] | | Cygwin Terminal (for Win) | [https://www.cygwin.com/] |