refactor: make tests agnostic from the running path (#358)

Author: kronenthaler

.github/workflows/publish.yml

@@ -27,5 +27,5 @@ jobs:
           python setup.py sdist bdist_wheel
           twine upload dist/*
         env:
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

Makefile

@@ -1,15 +1,15 @@
 .PHONY: coverage coverage-term test install-dependencies
 
 coverage: install-dependencies
-	cd tests; pytest --cov-report=xml --cov=../ --cov-branch
-	cd tests; rm -rf .coverage
+	pytest --cov-report=xml --cov=../ --cov-branch
+	rm -rf .coverage
 
 coverage-term: install-dependencies
-	cd tests; pytest --cov-report=term --cov=../ --cov-branch
-	cd tests; rm -rf .coverage
+	pytest --cov-report=term --cov=../ --cov-branch
+	rm -rf .coverage
 
 test:
-	cd tests; pytest
+	pytest
 
 install-dependencies:
 	pip3 install -r dev-requirements.txt

tests/pytest.ini renamed to pytest.ini

@@ -1,3 +1,4 @@
 [pytest]
 python_files = Test*.py
-pythonpath = ..
+pythonpath = .
+testpaths = tests

tests/TestXCodeProject.py

@@ -3,6 +3,7 @@
 import unittest
 
 from pbxproj import XcodeProject
+from os.path import join
 import re
 
 
@@ -37,13 +38,17 @@ def setUp(self):
             }
         }
 
+        self.pwd = os.getcwd()
+        os.chdir(os.path.dirname(os.path.abspath(__file__)))
+
         # create tmp directory for results
         if not os.path.exists("results"):
             os.mkdir("results")
 
     def tearDown(self):
         # remove tmp directory
         shutil.rmtree('results')
+        os.chdir(self.pwd)
 
     def testSaveOnGivenPath(self):
         XcodeProject().save("results/sample")
@@ -112,4 +117,3 @@ def testConsistency(self):
             saved = project.__repr__() + '\n'
 
             assert saved == original
-

tests/pbxcli/TestPBXCLI.py

@@ -6,16 +6,20 @@
 
 from pbxproj import XcodeProject
 from pbxproj.pbxcli import open_project, resolve_backup, backup_project, command_parser, PROJECT_PLACEHOLDER
+from tests.pbxcli import BASE_PROJECT_PATH
 import pytest
 
-BASE_PROJECT_PATH = 'samplescli/project.pbxproj'
-
 
 class PBXCLITest(unittest.TestCase):
+    def setUp(self):
+        self.pwd = os.getcwd()
+        os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
     def tearDown(self):
         if hasattr(self, 'backup_file') and self.backup_file:
             os.remove(self.backup_file)
         sys.stdout = sys.__stdout__
+        os.chdir(self.pwd)
 
     def testOpenProjectWithFullPath(self):
         project = open_project({PROJECT_PLACEHOLDER: BASE_PROJECT_PATH})

tests/pbxcli/TestPBXProjFile.py

@@ -6,20 +6,22 @@
 import pbxproj.pbxcli.pbxproj_file as pbxproj_file
 from pbxproj import PBXGenericObject
 from pbxproj.pbxcli import open_project, PROJECT_PLACEHOLDER, PATH_PLACEHOLDER
+from tests.pbxcli import BASE_PROJECT_PATH, SAMPLE_PROJECT_PATH
 import pytest
 
-SAMPLE_PROJECT_PATH = 'samplescli/test.pbxproj'
-BASE_PROJECT_PATH = 'samplescli/project.pbxproj'
-
 
 class PBXProjFileTest(unittest.TestCase):
     def setUp(self):
         # copy the project.pbxproj, into a file that can be used by the tests
+        self.pwd = os.getcwd()
+        os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
         shutil.copyfile(BASE_PROJECT_PATH, SAMPLE_PROJECT_PATH)
 
     def tearDown(self):
         os.remove(SAMPLE_PROJECT_PATH)
         sys.stdout = sys.__stdout__
+        os.chdir(self.pwd)
 
     def testRemoveFileUnknown(self):
         args = {

tests/pbxcli/TestPBXProjFlag.py

@@ -10,12 +10,16 @@
 
 class TestPBXProjFlag(unittest.TestCase):
     def setUp(self):
+        self.pwd = os.getcwd()
+        os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
         # copy the project.pbxproj, into a file that can be used by the tests
         shutil.copyfile(BASE_PROJECT_PATH, SAMPLE_PROJECT_PATH)
 
     def tearDown(self):
         os.remove(SAMPLE_PROJECT_PATH)
         sys.stdout = sys.__stdout__
+        os.chdir(self.pwd)
 
     def testAddFlags(self):
         args = {
@@ -56,4 +60,4 @@ def testRemoveFlags(self):
         assert result == 'Flags removed successfully.'
 
         for configuration in project.objects.get_configurations_on_targets(args['--target'], args['--configuration']):
-            assert 'MYFLAG' not in configuration.buildSettings
+            assert 'MYFLAG' not in configuration.buildSettings

tests/pbxcli/TestPBXProjFolder.py

@@ -7,20 +7,23 @@
 from pbxproj import PBXGenericObject
 from pbxproj.pbxcli import open_project, PROJECT_PLACEHOLDER, PATH_PLACEHOLDER
 from pbxproj.pbxextensions.ProjectFiles import TreeType
+from tests.pbxcli import BASE_PROJECT_PATH, SAMPLE_PROJECT_PATH
 import pytest
 
-SAMPLE_PROJECT_PATH = 'samplescli/test.pbxproj'
-BASE_PROJECT_PATH = 'samplescli/project.pbxproj'
-
 
 class PBXProjFolderTest(unittest.TestCase):
+
     def setUp(self):
+        self.pwd = os.getcwd()
+        os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
         # copy the project.pbxproj, into a file that can be used by the tests
         shutil.copyfile(BASE_PROJECT_PATH, SAMPLE_PROJECT_PATH)
 
     def tearDown(self):
         os.remove(SAMPLE_PROJECT_PATH)
         sys.stdout = sys.__stdout__
+        os.chdir(self.pwd)
 
     def testRemoveFolderUnknown(self):
         args = {

tests/pbxcli/TestPBXProjShow.py

@@ -10,12 +10,16 @@
 
 class PBXProjShowTest(unittest.TestCase):
     def setUp(self):
+        self.pwd = os.getcwd()
+        os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
         # copy the project.pbxproj, into a file that can be used by the tests
         shutil.copyfile(BASE_PROJECT_PATH, SAMPLE_PROJECT_PATH)
 
     def tearDown(self):
         os.remove(SAMPLE_PROJECT_PATH)
         sys.stdout = sys.__stdout__
+        os.chdir(self.pwd)
 
     def testShowAllTargetsInfo(self):
         args = {

tests/pbxcli/__init__.py

@@ -1,2 +1,2 @@
 SAMPLE_PROJECT_PATH = 'samplescli/test.pbxproj'
-BASE_PROJECT_PATH = 'samplescli/project.pbxproj'
+BASE_PROJECT_PATH = 'samplescli/project.pbxproj'

tests/pbxextensions/TestProjectFiles.py

@@ -41,6 +41,12 @@ def setUp(self):
             }
         }
 
+        self.pwd = os.getcwd()
+        os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
+    def tearDown(self):
+        os.chdir(self.pwd)
+
     def testInit(self):
         with pytest.raises(EnvironmentError, match='^This class cannot be instantiated directly'):
             ProjectFiles()