Feat/tests

.github/.codecov.yml

@@ -0,0 +1,3 @@
+ignore:
+  - "**/test_*.py"
+  - "usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests"

.github/workflows/unittests.yml

@@ -0,0 +1,37 @@
+name: Unittests
+on: [push]
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: '3.10'
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: '3.10'
+    - name: Generate coverage report
+      run: |
+        sudo apt-get update
+        sudo apt-get install build-essential python3-dev \
+          libldap2-dev libsasl2-dev slapd ldap-utils tox \
+          lcov valgrind
+
+        pip install pytest
+        pip install pytest-cov
+        cd ./usr/lib/python3/dist-packages/linuxmusterLinuxclient7
+        pip install -r requirements.txt
+
+        pytest --cov=./ --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
+        files: ./usr/lib/python3/dist-packages/linuxmusterLinuxclient7/coverage.xml

.gitignore

@@ -10,3 +10,7 @@ debian/linuxmuster-linuxclient7.substvars
 debian/linuxmuster-linuxclient7/
 __pycache__
 /public
+venv
+.coverage
+coverage.xml
+.vscode/*.log

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
     "recommendations": [
         "njpwerner.autodocstring",
-        "ms-python.python"
+        "ms-python.python",
+        "ryanluker.vscode-coverage-gutters"
     ]
 }

Makefile

@@ -5,6 +5,9 @@ help:
 	@echo "  deb    Build debian package"
 	@echo "  docs   Build Sphinx documentation"
 	@echo "  clean  Remove built files"
+	@echo "  tests  Run tests"
+	@echo "  help   Show this help"
+
 
 deb:
 	dpkg-buildpackage -rfakeroot -tc -sa -us -uc -I".directory" -I".git" -I"buildpackage.sh"
@@ -13,4 +16,7 @@ docs:
 	cd docs && sphinx-build . ../public
 
 clean:
-	rm -r public
+	rm -r public
+
+tests:
+	pytest -vv --cov=./ --cov-report=xml

README.md

@@ -12,8 +12,11 @@
   <a href="https://www.gnu.org/licenses/agpl-3.0">
     <img src="https://img.shields.io/badge/License-AGPL%20v3-blue.svg" />
   </a>
-  <a href="https://github.com/linuxmuster/linuxmuster-linuxclient7/actions/workflows/release.yml">
-    <img src="https://github.com/linuxmuster/linuxmuster-linuxclient7/workflows/Build%20Release/badge.svg" />
+  <a href="https://codecov.io/gh/linuxmuster/linuxmuster-linuxclient7">
+    <img src="https://codecov.io/gh/linuxmuster/linuxmuster-linuxclient7/branch/feat/tests/graph/badge.svg?token=V9XYC91882"/>
+  </a>
+  <a href="https://github.com/linuxmuster/linuxmuster-linuxclient7/actions/workflows/unittests.yml">
+    <img src="https://github.com/linuxmuster/linuxmuster-linuxclient7/actions/workflows/unittests.yml/badge.svg" />
   </a>
   <a href="https://ask.linuxmuster.net">
     <img src="https://img.shields.io/discourse/users?logo=discourse&amp;logoColor=white&amp;server=https%3A%2F%2Fask.linuxmuster.net" alt="Community Forum" />
@@ -24,9 +27,9 @@
 Package for Ubuntu clients to connect to the linuxmuster.net 7 active directory server.  
 This is the new version of the linuxmuster-client-adsso package.  
 - For user documentation, take a look at the [wiki](https://github.com/linuxmuster/linuxmuster-linuxclient7/wiki).
-- For developmer documentation, take a look at the [documentation](https://linuxmuster.github.io/linuxmuster-linuxclient7)
+- For developer documentation, take a look at the [documentation](https://linuxmuster.github.io/linuxmuster-linuxclient7)
 
-## Maintainance Details
+## Maintenance Details
 
 Linuxmuster.net official | ❌ NO*
 :---: | :---: 
@@ -36,7 +39,7 @@ Maintainer organisation |  Netzint GmbH
 Primary maintainer | [email protected] / [email protected]  
 
 \* Even though this is not an official package, pull requests and issues are being looked at.  
-** The linuxmuster community consits of people who are nice and happy to help. They are not directly involved in the development though, and might not be able to help in any case.
+** The linuxmuster community consists of people who are nice and happy to help. They are not directly involved in the development though, and might not be able to help in any case.
 
 ## Version schema:
 - General: `major.minor.patch`
@@ -45,3 +48,16 @@ Primary maintainer | [email protected] / [email protected]
 - Releases are always prefixed with `release`.
   - So, once version `7.1.1` is ready, it is published as `7.1.1-release`
 - This concept ensures that stable releases are always evaluated as a higher version number than pre-releases.
+
+## Setup development environment
+
+Tested with Python 3.10:
+
+1. `python3 -m venv ./venv`
+2. `. ./venv/bin/activate`
+3. `cd ./usr/lib/python3/dist-packages/linuxmusterLinuxclient7`
+4. `pip install -r requirements.txt`
+
+To run tests:
+1. `pytest`
+2. with coverage: `pytest --cov=./ --cov-report=xml`

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/constants.py

@@ -5,6 +5,8 @@
 defaultDomainAdminUser = "global-admin"
 
 # {} will be substituted for the username
+gtkBookmarksFile = "/home/{}/.config/gtk-3.0/bookmarks"
+
 shareMountBasepath = "/home/{}/media"
 hiddenShareMountBasepath = "/srv/samba/{}"
 machineAccountSysvolMountPath = "/var/lib/samba/sysvol"

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/environment.py

@@ -12,7 +12,7 @@ def export(keyValuePair):
     """
     logging.debug("Saving export '{}' to tmp file".format(keyValuePair))
 
-    envList = keyValuePair.split("=")
+    envList = keyValuePair.split("=", 1)
     if len(envList) == 2:
         os.putenv(envList[0], envList[1])
 

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/fileHelper.py

@@ -8,7 +8,7 @@ def removeLinesInFileContainingString(filePath, forbiddenStrings):
     :param filePath: The path to the file
     :type filePath: str
     :param forbiddenStrings: The string to search for
-    :type forbiddenStrings: str
+    :type forbiddenStrings: str or list[str]
     :return: True on success, False otherwise
     :rtype: bool
     """
@@ -48,12 +48,12 @@ def deleteFile(filePath):
 
     :param filePath: The path of the file
     :type filePath: str
-    :return: True on success, False otherwise
+    :return: True on success or if the file does not exist, False otherwise
     :rtype: bool
     """
     try:
         if os.path.exists(filePath):
-            os.unlink(filePath)
+            os.remove(filePath)
         return True
     except Exception as e:
         logging.error("Failed!")
@@ -68,7 +68,7 @@ def deleteFilesWithExtension(directory, extension):
     :type directory: str
     :param extension: The file extension
     :type extension: str
-    :return: True on success, False otherwise
+    :return: True on success or if the path does not exist, False otherwise
     :rtype: bool
     """
     if directory.endswith("/"):
@@ -105,11 +105,11 @@ def deleteDirectory(directory):
 
 def deleteAllInDirectory(directory):
     """
-    Delete all files in a given directory
+    Delete all files and folders in a given directory
 
     :param directory: The path of the directory
     :type directory: str
-    :return: True on success, False otherwise
+    :return: True on success or if the directory does not exist, False otherwise
     :rtype: bool
     """