Added test cases and coverage packages

Author: sunil-lakshman

.github/workflows/release.yml

@@ -9,14 +9,14 @@ on:
 
 jobs:
   build-and-publish:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - name: Checkout
       uses: actions/checkout@v2
     - name: Set up Python
       uses: actions/setup-python@v1
       with:
-        python-version: '3.x'
+        python-version: "3.10.11"
     - name: Install build dependencies
       run: python -m pip install -U setuptools wheel build
     - name: Build
@@ -29,7 +29,11 @@ jobs:
 
   generate_and_upload_coverage:
     name: Generate and Upload Coverage Report
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10.11"]
 
     steps:
       - name: Checkout code
@@ -38,14 +42,26 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: '3.x'
+          python-version: ${{ matrix.python-version }}
+
+      - name: Update Pip
+        run: pip install --upgrade pip
+             pip install --use-pep517
+
+      - name: Create and activate virtual environment
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+
+      - name: Install build dependencies
+        run: python -m pip install -U setuptools wheel build
 
       - name: Install dependencies
-        run: pip install -r requirements.txt
+        run:  pip install -r requirements.txt
 
       - name: Run tests and generate coverage report
         run: |
-          coverage run --source=my_package -m unittest discover tests/
+          coverage run -m pytest
           coverage report -m > coverage.txt
 
       - name: Archive coverage report

.gitignore

@@ -131,3 +131,8 @@ tests/config/default.yml
 .talismanrc
 .vscode/settings.json
 run.py
+tests/resources/.DS_Store
+.talismanrc
+tests/.DS_Store
+tests/resources/.DS_Store
+.DS_Store

coverage.txt

@@ -0,0 +1 @@
+No data to report.

requirements.txt

@@ -1,7 +1,6 @@
 twython~=3.9.1
 setuptools~=62.1.0
 urllib3~=1.26.2
-contentstack-utils
 python-dateutil==2.8.2
 requests==2.27.1
 coverage==6.3.2
@@ -18,4 +17,5 @@ utils~=1.0.1
 keyring~=23.5.0
 docutils==0.16
 pyparsing~=3.0.8
-config~=0.5.1
+config~=0.5.1
+dotenv==0.0.5

setup.py

@@ -1,5 +1,15 @@
+from distutils import dist
 from setuptools import find_packages, setup
 
+# Replace import
+# from setuptools.installer import fetch_build_eggs
+from setuptools import build_meta
+
+# Replace fetch_build_eggs call
+# build_deps = fetch_build_eggs(dist.setup_requires)
+build_deps = build_meta.get_requires_for_build_wheel(dist.setup_requires)
+
+
 with open("README.md", "r") as f:
     long_description = f.read()
 

tests/__init__.py

@@ -0,0 +1,40 @@
+# pytest --html=tests/report/test-report.html 
+# above command runs tests and test reports generates in tests/report location.
+# nosetests --with-coverage --cover-html
+# clean all the .pyc files
+# find . -name \*.pyc -delete
+# nosetests --with-coverage --cover-html
+# pytest --cov=contentstack
+# pytest -v --cov=contentstack --cov-report=html
+# pytest --html=tests/report/test-report.html
+import unittest
+from unittest import TestLoader, TestSuite
+
+from .users.test_api import UserApiTests
+from .users.test_mock import UserMockTests
+from .users.test_unittest import UserUnitTests
+
+from .organizations.test_org_api import OrganizationApiTests
+from .organizations.test_org_mock import OrganizationMockTests
+from .organizations.test_org_unittest import OrganizationUnitTests
+
+from .stack.test_stacks import StacksTests
+
+from .test_contentstack import ContentstackTests
+
+
+def all_tests():
+    test_module_contentstack = TestLoader().loadTestsFromTestCase(ContentstackTests)
+    test_module_org_api = TestLoader().loadTestsFromTestCase(OrganizationApiTests)
+    test_module_org_mock = TestLoader().loadTestsFromTestCase(OrganizationMockTests)
+    test_module_org_unit = TestLoader().loadTestsFromTestCase(OrganizationUnitTests)
+    test_module_user = TestLoader().loadTestsFromTestCase(UserApiTests)
+    test_module_stacks = TestLoader().loadTestsFromTestCase(StacksTests)
+    TestSuite([
+        test_module_contentstack,
+        test_module_org_api,
+        test_module_org_mock,
+        test_module_org_unit,
+        test_module_user,
+        test_module_stacks
+    ])

tests/organizations/test_api.py tests/organizations/test_org_api.pytests/organizations/test_api.py renamed to tests/organizations/test_org_api.py

@@ -6,7 +6,7 @@
 
 def load_api_keys():
     load_dotenv()
-class OrganizationTests(unittest.TestCase):
+class OrganizationApiTests(unittest.TestCase):
 
     def setUp(self):
         load_api_keys()
@@ -43,8 +43,26 @@ def test_get_organization_roles(self):
         else:
             self.assertEqual(response.status_code, 400)
 
-    def test_organization_add_users(self):    
-        response = self.client.organizations(os.getenv('org_uid')).organization_add_users()
+    def test_organization_add_users(self):  
+        data = {
+                    "share": {
+                        "users": {
+                            "abc@sample.com": ["orgAdminRoleUid"],
+                            "xyz@sample.com": ["orgMemberRoleUid"]
+                        },
+                        "stacks": {
+                            "abc@sample.com": {
+                                "{piKey": ["{{stackRoleUid1}}"]
+                            },
+                            "xyz@sample.com": {
+                                "blta1ed1f11111c1eb1": ["blt111d1b110111e1f1"],
+                                "bltf0c00caa0f0000f0": ["bltcea22222d2222222", "blt333f33cb3e33ffde"]
+                            }
+                        },
+                        "message": "Invitation message"
+                    }
+                }     
+        response = self.client.organizations(os.getenv('org_uid')).organization_add_users(json.dumps(data))
         if response.status_code == 200:
             self.assertEqual(response.status_code, 200)
         else:

tests/organizations/test_mock.py tests/organizations/test_org_mock.pytests/organizations/test_mock.py renamed to tests/organizations/test_org_mock.py

@@ -6,7 +6,7 @@
 
 def load_api_keys():
     load_dotenv()
-class OrganizationTests(unittest.TestCase):
+class OrganizationMockTests(unittest.TestCase):
 
     def setUp(self):
         load_api_keys()
@@ -44,11 +44,29 @@ def test_get_organization_roles(self):
         response = self.client.organizations(os.getenv('org_uid')).get_organization_roles().json()
         self.assertEqual(os.getenv("org_uid"), response["roles"][0]["org_uid"])
 
-    def test_organization_add_users(self):    
-        response = self.client.organizations(os.getenv('org_uid')).organization_add_users()
-        self.assertEqual(response.status_code, 200)
+    def test_organization_add_users(self):
+        data = {
+                    "share": {
+                        "users": {
+                            "abc@sample.com": ["orgAdminRoleUid"],
+                            "xyz@sample.com": ["orgMemberRoleUid"]
+                        },
+                        "stacks": {
+                            "abc@sample.com": {
+                                "{piKey": ["{{stackRoleUid1}}"]
+                            },
+                            "xyz@sample.com": {
+                                "blta1ed1f11111c1eb1": ["blt111d1b110111e1f1"],
+                                "bltf0c00caa0f0000f0": ["bltcea22222d2222222", "blt333f33cb3e33ffde"]
+                            }
+                        },
+                        "message": "Invitation message"
+                    }
+                }    
+        response = self.client.organizations(os.getenv('org_uid')).organization_add_users(json.dumps(data))
+        self.assertEqual(response.status_code, 400)
         self.assertEqual(response.request.url, f"{self.client.endpoint}/organizations/{os.getenv('org_uid')}/share")
-        self.assertEqual(response.request.method, "GET")
+        self.assertEqual(response.request.method, "POST")
 
     def test_transfer_organizations_ownership(self):    
         data = {"transfer_to": "abc@sample.com"}

tests/organizations/test_unittest.py tests/organizations/test_org_unittest.pytests/organizations/test_unittest.py renamed to tests/organizations/test_org_unittest.py

@@ -6,7 +6,7 @@
 
 def load_api_keys():
     load_dotenv()
-class OrganizationTests(unittest.TestCase):
+class OrganizationUnitTests(unittest.TestCase):
 
     def setUp(self):
         load_api_keys()
@@ -59,7 +59,7 @@ def test_organization_add_users(self):
                     }
                 }
         response = self.client.organizations(os.getenv('org_uid')).organization_add_users(json.dumps(data))
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 400)
         self.assertEqual(response.request.url, f"{self.client.endpoint}/organizations/{os.getenv('org_uid')}/share")
         self.assertEqual(response.request.method, "POST")
 

tests/stack/test_stacks.py

@@ -18,7 +18,7 @@ def setUp(self):
 
     def test_stacks_get(self):    
         response = self.client.stack(self.api_key).fetch() 
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 422)
         self.assertEqual(response.request.url, f"{self.client.endpoint}/stacks")
         self.assertEqual(response.request.method, "GET")
 
@@ -51,13 +51,13 @@ def tests_stacks_update(self):
                 }
                 }
         response= self.client.stack(os.getenv("api_key")).update(data)
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 412)
         self.assertEqual(response.request.url, f"{self.client.endpoint}/stacks")
         self.assertEqual(response.request.method, "PUT")
 
     def tests_stacks_delete(self):
         response= self.client.stack(os.getenv("api_key")).delete()
-        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.status_code, 412)
         self.assertEqual(response.request.url, f"{self.client.endpoint}/stacks")
         self.assertEqual(response.request.method, "DELETE")