Split retry from wait and remove Yarn (#12)

* removed yarn dependency and moved retry actions out of wait operations
* updated classes that rely on wait functions to use new retry actions
* added configuration options for delay and delayType to facet classes
* v9.0.0
* fixed error handling in httpservice.performRequest so no uncaught exceptions occur outside the promise
* added more tests to aft-examples and added aft-mocha-reporter to demonstrate its usage
* added browserstack auth env vars to dev container
* added functional test execution to github actions on Pull Requests from within this repo
* added typedoc documentation generator and docs directory containing generated documentation
* improved inline code documentation
* set osx browser to latest version for browserstack functional test to prevent possibility of sendKeys failure

.devcontainer/Dockerfile

@@ -0,0 +1,14 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=16-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node packages
+# RUN su node -c "npm install -g <your-package-list -here>"

.devcontainer/base.Dockerfile

@@ -0,0 +1,17 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=16-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
+
+# Install tslint, typescript. eslint is installed by javascript image
+ARG NODE_MODULES="tslint-to-eslint-config typescript"
+COPY library-scripts/meta.env /usr/local/etc/vscode-dev-containers
+RUN su node -c "umask 0002 && npm install -g ${NODE_MODULES}" \
+    && npm cache clean --force > /dev/null 2>&1
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"

.devcontainer/devcontainer.json

@@ -0,0 +1,42 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick a Node version: 18, 16, 14.
+		// Append -bullseye or -buster to pin to an OS version.
+		// Use -bullseye variants on local on arm64/Apple Silicon.
+		"args": { 
+			"VARIANT": "18"
+		}
+	},
+
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"dbaeumer.vscode-eslint"
+			]
+		}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "npm install",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "node",
+	"features": {
+		"git": "os-provided"
+	},
+
+	"containerEnv": {
+		"browserstack_user": "${localEnv:browserstack_user}",
+		"browserstack_key": "${localEnv:browserstack_key}"
+	}
+}

.github/workflows/build-test-deploy-main.yml

@@ -10,12 +10,22 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
-      - run: yarn install
-      - run: yarn build
-      - run: yarn test
-      - run: cp .npmrc-publish ~/.npmrc
-      - run: yarn lerna publish from-package --yes
+          node-version: '18'
+      - name: Install Dependencies
+        id: installdeps
+        run: npm ci
+      - name: Build Projects
+        id: buildproj
+        run: npm run build
+      - name: Run Unit Tests
+        id: unittest
+        run: npm run test
+      - name: Update NPM Credentials File
+        id: updatecredsfile
+        run: cp .npmrc-publish ~/.npmrc
+      - name: Publish to NPM
+        id: publishpackages
+        run: npx lerna publish from-package --yes
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           NPM_USER: ${{ secrets.NPM_USER }}

.github/workflows/build-test-pull-requests.yml

@@ -10,7 +10,21 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
-      - run: yarn install
-      - run: yarn build
-      - run: yarn test
+          node-version: '18'
+      - name: Install Dependencies
+        id: installdeps
+        run: npm ci
+      - name: Build Projects
+        id: buildproj
+        run: npm run build
+      - name: Run Unit Tests
+        id: unittest
+        run: npm run test
+      - name: Functional Test
+        # only run functional tests on internal PRs
+        if: github.repository == 'bicarbon8/automated-functional-testing'
+        id: functionaltest
+        run: npm run test-examples
+        env:
+          browserstack_user: ${{ secrets.BROWSERSTACK_USER }}
+          browserstack_key: ${{ secrets.BROWSERSTACK_KEY }}

.npmignore

@@ -2,4 +2,6 @@ src/
 test/
 node_modules/
 .vscode/
-dist/test/
+dist/test/
+FileSystemMap/
+logs/

README.md

@@ -70,8 +70,12 @@ verify(() => {throw new Error('failure');}) // AFT will report as 'failed'
 
 ## Packages (click on name for more info)
 - [`aft-core`](./packages/aft-core/README.md) - base library containing helpers and configuration and plugin managers
+- [`aft-examples`](./packages/aft-examples/README.md) - provides real-world examples of how the AFT libraries can be used in functional tests
+- [`aft-jasmine-reporter`](./packages/aft-jasmine-reporter/README.md) - a Jasmine Reporter Plugin that integrates with AFT to simplify logging and test execution via AFT
 - [`aft-logging-awskinesis`](./packages/aft-logging-awskinesis/README.md) - logging plugin supporting logging to AWS Kinesis Firehose
+- [`aft-logging-filesystem`](./packages/aft-logging-filesystem/README.md) - logging plugin supporting logging to .log files for all log output
 - [`aft-logging-html`](./packages/aft-logging-html/README.md) - logging plugin supporting logging to a HTML results file
+- [`aft-mocha-reporter`](./packages/aft-mocha-reporter/README.md) - provides Mocha Reporter Plugin that integrates with AFT to simplify logging and test execution via AFT
 - [`aft-testrail`](./packages/aft-testrail/README.md) - logging and test case management plugins supporting logging test results and filtering test execution based on TestRail Projects, Suites and Plans
 - [`aft-ui`](./packages/aft-ui/README.md) - base library supporting development of UI testing packages
 - [`aft-ui-browsers`](./packages/aft-ui-browsers/README.md) - adds support for Selenium-based UI testing using BrowserStack, Sauce Labs or your own Selenium Grid
@@ -130,13 +134,18 @@ the purpose of a `DefectPlugin` implementation is to provide execution control o
 ## Contributing to AFT
 - create a Fork of the repo in GitHub
 - clone the code using `git clone https://github.com/<your-project-area>/automated-functional-testing automated-functional-testing` where `<your-project-area>` is replaced with the location of your Fork
-- install yarn using `npm i yarn -g` _(if you don't already have it installed)_
-- run `yarn install` to install all dependencies
-- run a build to ensure `yarn` understands and caches the project layout using `yarn build`
-  - NOTE: you can build each project individually using `yarn workspace <project-name> build` where `<project-name>` is a value like `aft-core` or `aft-ui`
-- run the tests using `yarn test` or individually using `yarn workspace <project-name> test`
+- run `npm install` to install all dependencies
+- run a build to ensure `npm workspaces` understands and caches the project layout using `npm run build`
+  - NOTE: you can build each project individually using `npm run build --workspace=<project-name>` where `<project-name>` is a value like `aft-core` or `aft-ui`
+- run the tests using `npm run test` or individually using `npm run test --workspace=<project-name>`
 - when you are happy with your changes, submit a Pull Request back to the _main_ branch at https://github.com/bicarbon8/automated-functional-testing
 
-> NOTE: all changes require unit tests and these tests are expected to pass when run via `yarn test`
 
-> NOTE: check for any circular dependencies using `yarn run dpdm -T --warning false **/index.ts`
+## NOTES
+> all changes require unit tests and these tests are expected to pass when run via `npm run test`
+
+> check for any circular dependencies using `npx dpdm -T --warning false **/index.ts`
+
+> use `npx lerna version` to automatically update the version of all projects at once (all changes must be committed first)
+
+> generate documentation using `npx typedoc --entryPointStrategy packages ./packages/* --out ./docs`

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,134 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #0000FF;
+    --dark-hl-3: #569CD6;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #267F99;
+    --dark-hl-5: #4EC9B0;
+    --light-hl-6: #008000;
+    --dark-hl-6: #6A9955;
+    --light-hl-7: #AF00DB;
+    --dark-hl-7: #C586C0;
+    --light-hl-8: #EE0000;
+    --dark-hl-8: #D7BA7D;
+    --light-hl-9: #098658;
+    --dark-hl-9: #B5CEA8;
+    --light-hl-10: #0070C1;
+    --dark-hl-10: #4FC1FF;
+    --light-hl-11: #0451A5;
+    --dark-hl-11: #9CDCFE;
+    --light-hl-12: #CD3131;
+    --dark-hl-12: #F44747;
+    --light-hl-13: #811F3F;
+    --dark-hl-13: #D16969;
+    --light-hl-14: #D16969;
+    --dark-hl-14: #CE9178;
+    --light-hl-15: #000000;
+    --dark-hl-15: #D7BA7D;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --hl-14: var(--light-hl-14);
+    --hl-15: var(--light-hl-15);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --hl-14: var(--dark-hl-14);
+    --hl-15: var(--dark-hl-15);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --hl-14: var(--light-hl-14);
+    --hl-15: var(--light-hl-15);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --hl-14: var(--dark-hl-14);
+    --hl-15: var(--dark-hl-15);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+.hl-12 { color: var(--hl-12); }
+.hl-13 { color: var(--hl-13); }
+.hl-14 { color: var(--hl-14); }
+.hl-15 { color: var(--hl-15); }
+pre, code { background: var(--code-background); }