Update README and workflow_dispatch (#295)

## 📝 Description

updating README and workflow_dispatch
remove /acctest command

## ✔️ How to Test

Refer to Testing section in README

**How do I run the relevant unit/integration tests?**

## 📷 Preview

**If applicable, include a screenshot or code snippet of this change.
Otherwise, please remove this section.**

Author: ykim-akamai

.github/workflows/e2e-test-pr-command.yml

@@ -1,18 +1,24 @@
 on:
   pull_request:
-  repository_dispatch:
-    types: [acctest-command]
+  workflow_dispatch:
+    inputs:
+      test_path:
+        description: 'Enter specific test path. E.g. linode_client/test_linode_client.py, models/test_account.py'
+        required: false
+      sha:
+        description: 'The hash value of the commit.'
+        required: true
+      pull_request_number:
+        description: 'The number of the PR.'
+        required: false
 
 name: PR E2E Tests
 
 jobs:
-  # Maintainer has commented /acctest on a pull request
   integration-fork-ubuntu:
     runs-on: ubuntu-latest
     if:
-      github.event_name == 'repository_dispatch' &&
-      github.event.client_payload.slash_command.sha != '' &&
-      github.event.client_payload.pull_request.head.sha == github.event.client_payload.slash_command.sha
+      github.event_name == 'workflow_dispatch' && inputs.sha != ''
 
     steps:
       - uses: actions-ecosystem/action-regex-match@v2
@@ -26,7 +32,7 @@ jobs:
       - name: Checkout PR
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.client_payload.slash_command.sha }}
+          ref: ${{ inputs.sha }}
 
       - name: Update system packages
         run: sudo apt-get update -y
@@ -47,16 +53,16 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - run: make testint
+      - run: make INTEGRATION_TEST_PATH="${{ inputs.test_path }}" testint
         if: ${{ steps.validate-tests.outputs.match == '' }}
         env:
           LINODE_CLI_TOKEN: ${{ secrets.LINODE_TOKEN }}
 
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
         id: update-check-run
-        if: ${{ always() }}
+        if: ${{ inputs.pull_request_number != '' }}
         env:
-          number: ${{ github.event.client_payload.pull_request.number }}
+          number: ${{ inputs.pull_request_number }}
           job: ${{ github.job }}
           conclusion: ${{ job.status }}
         with:

.github/workflows/e2e-test-pr.yml

@@ -1,6 +1,16 @@
 PYTHON ?= python3
 
 INTEGRATION_TEST_PATH :=
+TEST_CASE_COMMAND :=
+MODEL_COMMAND :=
+
+ifdef TEST_CASE
+TEST_CASE_COMMAND = -k $(TEST_CASE)
+endif
+
+ifdef TEST_MODEL
+MODEL_COMMAND = models/$(TEST_MODEL)
+endif
 
 @PHONEY: clean
 clean:
@@ -50,4 +60,4 @@ lint:
 
 @PHONEY: testint
 testint:
-	python3 -m pytest test/integration/
+	python3 -m pytest test/integration/${INTEGRATION_TEST_PATH}${MODEL_COMMAND} ${TEST_CASE_COMMAND}

Makefile

@@ -101,7 +101,7 @@ Contributing
 Tests
 -----
 
-Tests live in the ``tests`` directory.  When invoking tests, make sure you are
+Tests live in the ``test`` directory.  When invoking tests, make sure you are
 in the root directory of this project.  To run the full suite across all
 supported python versions, use tox_:
 
@@ -133,6 +133,35 @@ from the api base url that should be returned, for example::
 
 .. _tox: http://tox.readthedocs.io
 
+
+Integration Tests
+-----------
+Integration tests live in the ``test/integration`` directory.
+
+Pre-requisite
+^^^^^^^^^^^^^^^^^
+Export Linode API token as `LINODE_CLI_TOKEN` before running integration tests::
+
+    export LINODE_TOKEN = $(your_token)
+
+Running the tests
+^^^^^^^^^^^^^^^^^
+Run the tests locally using the make command. Run the entire test suite using command below::
+
+    make testint
+
+To run a specific package, use environment variable `INTEGRATION_TEST_PATH` with `testint` command::
+
+    make INTEGRATION_TEST_PATH="linode_client" testint
+
+To run a specific model test suite, set the environment variable `TEST_MODEL` using file name in `integration/models`::
+
+    make TEST_MODEL="test_account.py" testint
+
+Lastly to run a specific test case use environment variable `TEST_CASE` with `testint` command::
+
+    make TEST_CASE=test_get_domain_record testint
+
 Documentation
 -------------