Replacing postman tests with prism mock server

Replacing postman tests with prism mock server

Author: sangeet-joy-tw

.github/workflows/build-test-lint.yml

@@ -16,7 +16,7 @@ jobs:
 
             - name: Set up Python environment
               uses: actions/setup-python@v5
-              with: 
+              with:
                 python-version: '3.8'
                 cache: 'pip'
 
@@ -27,20 +27,37 @@ jobs:
                 pip install --upgrade pip
                 pip install black
                 sudo pip install flake8
+                sudo pip install pip-audit
                 pip install -r requirements.txt -r requirements/dev.txt
               working-directory: xero-python
-                
+
             - name: Run Flake8
               run: flake8 xero_python
               working-directory: xero-python
-                
+
             - name: Build package
               run: python setup.py sdist
               working-directory: xero-python
 
-            # - name: Run Test
-            #   run: |
-            #     source venv/bin/activate
-            #     pip install -r requirements/test.txt
-            #     pytest -v
-            #   working-directory: xero-python
+            - name: Set up Node environment
+              uses: actions/setup-node@v2
+              with:
+                node-version: 20
+
+            - name: Install Prism
+              run: npm install -g @stoplight/prism-cli
+
+            - name: Start PRISM Server
+              run: ./start-prism.sh & sleep 15
+              working-directory: xero-python/tests/utils
+
+            - name: Run Test
+              run: |
+                source venv/bin/activate
+                pytest -v
+              working-directory: xero-python
+
+            - name: Stop PRISM
+              if: success() || failure()
+              run: pkill -f prism
+              working-directory: xero-python

README.md

@@ -18,6 +18,7 @@ The xero-python SDK makes it easy for developers to access Xero's APIs in their
 - [Helper Methods](#helper-methods)
 - [Usage Examples](#usage-examples)
 - [SDK conventions](#sdk-conventions)
+- [Running Test(s) in Local](#running-tests-in-local)
 - [Participating in Xero’s developer community](#participating-in-xeros-developer-community)
 - [Contributing](#contributing)
 
@@ -540,6 +541,18 @@ created_invoice_attachments_by_file_name = accounting_api.create_invoice_attachm
 ---
 ## SDK conventions
 
+
+---
+## Running Test(s) in Local
+For Running Test cases PRISM Mock Server needs to be started in the local machine.
+Steps to Run Test(s)
+* Install PRISM from npm using the command:  **npm install -g @stoplight/prism-cli**
+* Verify Installation: **prism --version**
+* Navigate to **tests--> utils--> ** folder in the terminal
+* Execute the script **./start-prism.sh**
+* This will start the PRISM Server in Local
+* Run **pytest** to run the Python test cases.
+
 ### Querying & Filtering
 
 Describe the support for query options and filtering