Version 1.1.2

.github/workflows/unit-test.yml

@@ -0,0 +1,47 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Unit tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=35 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest --cov-report=xml --cov=src/IntuneCD tests/
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      if: matrix.python-version == 3.8
+      with:
+        files: ./coverage.xml
+        flags: unittests
+        fail_ci_if_error: true

.gitignore

@@ -17,4 +17,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
-.idea/
+.idea/
+__pycache__/
+.pytest_cache/
+.coverage

README.md

@@ -3,6 +3,8 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/IntuneCD?style=flat-square)
 ![PyPI](https://img.shields.io/pypi/v/IntuneCD?style=flat-square)
 ![Maintenance](https://img.shields.io/maintenance/yes/2022?style=flat-square)
+![Unit tests](https://github.com/almenscorner/IntuneCD/actions/workflows/unit-test.yml/badge.svg)
+![Publish](https://github.com/almenscorner/IntuneCD/actions/workflows/pypi-publish.yml/badge.svg)
 
 ![IntuneCDlogo2](https://user-images.githubusercontent.com/78877636/156755733-b66a4381-9a9a-4663-9d27-e55a1281e1fa.png)
 
@@ -14,6 +16,19 @@ The main function is to back up configurations from Intune to a Git repository f
 
 The package can also be run standalone outside a pipeline, or in one to only backup data. Since 1.0.4, configurations are also created if they cannot be found. This means this tool could be used in a tenant to tenant migration scenario as well.
 
+## What's new in 1.1.2
+- Added new exclusions for backup and update, it's now possible to exclude certain configurations from backup and update.
+  - Example to exclude in backup: `IntuneCD-startbackup -e assignments AppConfigurations Profiles`
+  - Example to exclude in update: `IntuneCD-startupdate -e AppConfigurations Profiles`
+- Added capabilities to update the IntuneCD frontend with data
+  - Once the frontend is available all that will be needed to update with data is to add `-f <frontend_url>` to startbackup and startupdate command and set the API key in ENV variables.
+- Added ability to configure title, intro, tenant and updated lines in the documentation using a JSON string, example:
+  - `-j "{\"title\": \"demo\", \"intro\": \"demo\", \"tenant\": \"demo\", \"updated\": \"demo\"}"`  
+- Added unit tests
+- Changed deprecated OptionParser to ArgumentParser
+- Improved the documentation
+- Improved overall code readability
+
 ## What's new in 1.1.1
 - Added ability to split documentation into categories using `-s Y` in `intunecd-startdocumentation`
 - Added ability to set max length of output in documentation using `-m {int_value}` in `intunecd-startdocumentation`
@@ -26,28 +41,6 @@ The package can also be run standalone outside a pipeline, or in one to only bac
 - Bugfix for Windows Autopilot profiles not being able to update assignment in a tenant to tenant scenario
 - Bugfix for assignment updates where updating assignments when creating new configurations were not possible if the group does not exist
 
-## What's new in 1.0.9
-- Bugfix where the script exited with "local variable referenced before assignment" if a management intent does not exist
-- Added a new parameter to let you exclude assignments from backups. To exclude assignments from backup, you can now use `-e assignments` when running IntuneCD-startbackup.
-
-## What's new in 1.0.8
-Main focus for this release has been to improve the performance as large setups can take a while to backup/update. With these enhancements, I was able to cut the run time by 80% in most cases
-
-- Added module to use MS Graph batching to get assignments instead on getting them for each configuration individually
-- General code clean up
-- Added new module for getting and updating assignments, the old one was quite messy
-- For some configurations, additional information is appended to the filename, this is because there might be configurations with the same name
-    - App Configurations (appends odata type)
-    - App Protections (appends management type for ios/android and odata type for windows)
-    - Applications (for Windows it now appends the app type e.g. Win32 and version)
-    - Compliance (appends odata type)
-    - Profiles (appends odata type)
-- All configurations are now requested from the start and matched in script with displayName and/or odata type instead of requesting each configuration based on displayName
-- Management intents are now batched using the new batching module
-- Assignments are now batched using the new batching module
-- If 504 or 502 is encountered while getting configurations, the tool will now try again to get the configuration
-- For Windows apps in documentation, detection scripts etc will now have a "Click to expand..." instead of showing the whole script
-
 ## Install this package
 ```python
 pip install IntuneCD

codecov.yml

@@ -0,0 +1,5 @@
+ignore:
+  - "src/IntuneCD/run_backup.py"
+  - "src/IntuneCD/run_update.py"
+  - "src/IntuneCD/run_documentation.py"
+  - "src/IntuneCD/get_accesstoken.py"

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = IntuneCD
-version = 1.1.1
+version = 1.1.2
 author = Tobias Almén
 author_email = [email protected]
 description = Tool to backup and update configurations in Intune

src/IntuneCD/backup_AppProtection.py

@@ -2,64 +2,64 @@
 
 """
 This module backs up all App Protection Polices in Intune.
-
-Parameters
-----------
-path : str
-    The path to save the backup to
-output : str
-    The format the backup will be saved as
-token : str
-    The token to use for authenticating the request
 """
 
-import json
-import os
-import yaml
-
 from .clean_filename import clean_filename
 from .graph_request import makeapirequest
 from .graph_batch import batch_assignment, get_object_assignment
+from .save_output import save_output
+from .remove_keys import remove_keys
+
+# Set MS Graph endpoint
+ENDPOINT = "https://graph.microsoft.com/beta/deviceAppManagement/managedAppPolicies"
 
-## Set MS Graph endpoint
-endpoint = "https://graph.microsoft.com/beta/deviceAppManagement/managedAppPolicies"
 
-## Get all App Protection policies and save them in specified path
+# Get all App Protection policies and save them in specified path
 def savebackup(path, output, exclude, token):
-    configpath = path+"/"+"App Protection/"
-    data = makeapirequest(endpoint, token)
+    """
+    Saves all App Protection policies in Intune to a JSON or YAML file.
 
-    assignment_responses = batch_assignment(data,f'deviceAppManagement/','/assignments',token,app_protection=True)
+    :param path: Path to save the backup to
+    :param output: Format the backup will be saved as
+    :param token: Token to use for authenticating the request
+    """
+    config_count = 0
+    configpath = path + "/" + "App Protection/"
+    data = makeapirequest(ENDPOINT, token)
 
-    ## If profile is ManagedAppConfiguration, skip to next
+    assignment_responses = batch_assignment(
+        data,
+        'deviceAppManagement/',
+        '/assignments',
+        token,
+        app_protection=True)
+
+    # If profile is ManagedAppConfiguration, skip to next
     for profile in data['value']:
         if profile['@odata.type'] == "#microsoft.graph.targetedManagedAppConfiguration":
             continue
-
+
+        config_count += 1
+
         if "assignments" not in exclude:
-            assignments = get_object_assignment(profile['id'],assignment_responses)
+            assignments = get_object_assignment(
+                profile['id'], assignment_responses)
             if assignments:
                 profile['assignments'] = assignments
-
-        remove_keys = {'id', 'createdDateTime', 'version',
-                       'lastModifiedDateTime', 'deployedAppCount', 'isAssigned'}
-        for k in remove_keys:
-            profile.pop(k, None)
+
+        profile = remove_keys(profile)
 
         print("Backing up App Protection: " + profile['displayName'])
-        if os.path.exists(configpath) == False:
-            os.mkdir(configpath)
 
         if 'targetedAppManagementLevels' in profile:
-            fname = clean_filename(f"{profile['displayName']}_{profile['targetedAppManagementLevels']}")
+            fname = clean_filename(
+                f"{profile['displayName']}_{profile['targetedAppManagementLevels']}")
         else:
-            fname = clean_filename(f"{profile['displayName']}_{str(profile['@odata.type'].split('.')[2])}")
+            fname = clean_filename(
+                f"{profile['displayName']}_{str(profile['@odata.type'].split('.')[2])}")
 
-        ## Save App Protection as JSON or YAML depending on configured value in "-o"
-        if output != "json":
-            with open(configpath+fname+".yaml", 'w') as yamlFile:
-                yaml.dump(profile, yamlFile, sort_keys=False,
-                          default_flow_style=False)
-        else:
-            with open(configpath+fname+".json", 'w') as jsonFile:
-                json.dump(profile, jsonFile, indent=10)
+        # Save App Protection as JSON or YAML depending on configured value in
+        # "-o"
+        save_output(output, configpath, fname, profile)
+
+    return config_count

src/IntuneCD/backup_apns.py

@@ -2,47 +2,40 @@
 
 """
 This module backs up Apple Push Notification setting in Intune.
-
-Parameters
-----------
-path : str
-    The path to save the backup to
-output : str
-    The format the backup will be saved as
-token : str
-    The token to use for authenticating the request
 """
 
-import json
-import os
-import yaml
-
 from .clean_filename import clean_filename
 from .graph_request import makeapirequest
+from .save_output import save_output
+from .remove_keys import remove_keys
 
-## Set MS Graph endpoint
-endpoint = "https://graph.microsoft.com/beta/deviceManagement/applePushNotificationCertificate"
+# Set MS Graph endpoint
+ENDPOINT = "https://graph.microsoft.com/beta/deviceManagement/applePushNotificationCertificate"
 
-## Get APNs information and save in specified path
+
+# Get APNs information and save in specified path
 def savebackup(path, output, token):
-    configpath = path+"/"+"Apple Push Notification/"
-    data = makeapirequest(endpoint, token)
+    """
+    Save Apple Push Notification setting to a JSON or YAML file.
+
+    :param path: Path to save the backup to
+    :param output: Format the backup will be saved as
+    :param token: Token to use for authenticating the request
+    """
+
+    config_count = 0
+
+    configpath = path + "/" + "Apple Push Notification/"
+    data = makeapirequest(ENDPOINT, token)
 
     if data:
-        remove_keys = {'id', 'version', 'topicIdentifier', 'certificate'}
-        for k in remove_keys:
-            data.pop(k, None)
+        config_count += 1
+        data = remove_keys(data)
         print("Backing up Apple Push Notification: " + data['appleIdentifier'])
-        if os.path.exists(configpath) == False:
-            os.mkdir(configpath)
 
-        ## Get filename without illegal characters
+        # Get filename without illegal characters
         fname = clean_filename(data['appleIdentifier'])
-        ## Save APNs as JSON or YAML depending on configured value in "-o"
-        if output != "json":
-            with open(configpath+fname+".yaml", 'w') as yamlFile:
-                yaml.dump(data, yamlFile, sort_keys=False,
-                          default_flow_style=False)
-        else:
-            with open(configpath+fname+".json", 'w') as jsonFile:
-                json.dump(data, jsonFile, indent=10)
+        # Save APNs as JSON or YAML depending on configured value in "-o"
+        save_output(output, configpath, fname, data)
+
+    return config_count