first commit

Author: PeterYinusa

.env

@@ -0,0 +1,2 @@
+# MetaMask test seed https://github.com/MetaMask/metamask-extension/blob/v12.6.0/test/e2e/seeder/ganache.ts
+DAPPDRIVER_SEED_PHRASE="phrase upgrade clock rough situate wedding elder clever doctor stamp excess tent"

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install Dependencies
+        run: npm install
+      - name: Build Code
+        run: npm run build
+      - name: Install Playwright Browser
+        run: npx playwright install chrome
+      - name: Install Browser Extension
+        run: npm run setup
+      - name: Run All Tests
+        run: xvfb-run npm test

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+package-lock.json
+.vscode
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Assert Equals
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# DappDriver examples
+
+A set of examples to help demonstrate using [DappDriver](https://github.com/assert-equals/DappDriver).
+
+## Examples
+
+- [Cucumber](./packages/cucumber)
+- [Jest](./packages/jest)
+- [Mocha](./packages/mocha/)
+
+## Getting Started
+
+Install Dependancies
+
+```
+npm install
+```
+
+Build Code
+
+```
+npm run build
+```
+
+Install Playwright Browser
+
+```
+npx playwright install chrome
+```
+
+Install Browser Extension
+
+```
+npm run setup
+```
+
+Run All Tests
+
+```
+npm test
+```

package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@assert-equals/dappdriver-examples",
+  "version": "1.0.0",
+  "description": "A set of examples to help demonstrate using DappDriver",
+  "keywords": [
+    "cucumber",
+    "dappdriver",
+    "jest",
+    "mocha",
+    "playwright",
+    "rainbow",
+    "selenium",
+    "webdriver",
+    "zerion"
+  ],
+  "scripts": {
+    "build": "npm run build -ws --if-present",
+    "clean": "rm -rf node_modules package-lock.json && npm run clean -ws",
+    "setup": "npm run setup -ws --if-present",
+    "test": "npm test -ws --if-present"
+  },
+  "private": "true",
+  "workspaces": [
+    "packages/*"
+  ],
+  "license": "MIT"
+}

packages/cucumber/.gitignore

@@ -0,0 +1 @@
+node_modules

packages/cucumber/README.md

@@ -0,0 +1,35 @@
+# Cucumber
+
+An example to help demonstrate using DappDriver and [Cucumber](https://github.com/cucumber/cucumber-js) to test a sample dapp
+
+## Getting Started
+
+Install Dependancies
+
+```
+npm install
+```
+
+Build Code
+
+```
+npm run build
+```
+
+Install Playwright Browser
+
+```
+npx playwright install chrome
+```
+
+Install Browser Extension
+
+```
+npm run setup
+```
+
+Run All Tests
+
+```
+npm test
+```

packages/cucumber/cucumber.json

@@ -0,0 +1,6 @@
+{
+  "default": {
+    "requireModule": ["ts-node/register"],
+    "require": ["features/**/*.ts"]
+  }
+}

packages/cucumber/features/step_definitions/steps.ts

@@ -0,0 +1,20 @@
+import { Dapp } from "@assert-equals/dappdriver-examples-page-objects";
+import { Connect } from "@assert-equals/dappdriver/wallet";
+import { When, Then } from "@cucumber/cucumber";
+import { expect } from "chai";
+
+When("the user connects their wallet", async (): Promise<void> => {
+  let dapp: Dapp = new Dapp();
+  const connectPage: Connect = await dapp.connect();
+  dapp = await connectPage.accept<Dapp>(Dapp);
+  await dapp.waitForWindows(1);
+});
+
+Then(
+  "the dapp displays the users wallet {string}",
+  async (expectedAccount: string): Promise<void> => {
+    const dapp: Dapp = new Dapp();
+    const actualAccount: string = await dapp.getAccounts();
+    expect(actualAccount).to.be.equal(expectedAccount);
+  }
+);