Merge pull request #53 from magnusviri/main

magnusviri · web-flow · commit 79c0d27d43ba · 2021-09-12T22:34:55.000-06:00
Added github actions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,49 @@
+name: Build and test python-jamf
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-10.15, macos-11 ]
+        python-version: [ '3.7', '3.8', '3.9', 'pypy-3.7' ]
+    name: Build on ${{ matrix.os }} using ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Initialize Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+      - 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.
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Run Unit Tests
+        run: python -m unittest discover -s tests -p '*_test.py'
+  codeql:
+    name: Run CodeQL
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Initialize Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: python
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -0,0 +1,61 @@
+name: Build and publish python-jamf to Github and PyPI
+on:
+  push:
+    tags:
+      - '*'
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Initialize Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+      - 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.
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Run Unit Tests
+        run: python -m unittest discover -s tests -p '*_test.py'
+  release:
+    name: Release
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Build binary wheel and a source tarball
+        run: python setup.py sdist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_PASSWORD }}
+          repository_url: https://upload.pypi.org/legacy/
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: true
+          prerelease: false
+      - name: Publish to GitHub
+        uses: xresloader/upload-to-github-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          file: "dist/*"
+          release_id: ${{ steps.create_release.outputs.id }}
diff --git a/.gitignore b/.gitignore
@@ -15,4 +15,5 @@
 notes.md
 dist
 build
-archieve
+archive
+/jamf/VERSION
diff --git a/jamf/__init__.py b/jamf/__init__.py
@@ -10,5 +10,4 @@
 from . import package
 from . import convert
 from .records import *
-from .setconfig import setconfig
-__version__ = "0.6.5"
+from . import version
diff --git a/jamf/admin.py b/jamf/admin.py
@@ -690,7 +690,7 @@ def package_index(path, cleanup=True):
     # process all boms included in package
     boms = [x for x in boms.splitlines() if x]
     if not boms:
-        raise RuntimeError(f"no bill of materials found: {pkg}")
+        raise RuntimeError(f"no bill of materials found: {path}")
     # see `man lsbom` for formatting
     logger.debug(f"> lsbom -p fMguTsc '%s'", "', '".join(boms))
     cmd = ['/usr/bin/lsbom', '-p', 'fMguTsc'] + boms
@@ -702,7 +702,7 @@ def package_index(path, cleanup=True):
 
     if cleanup:
         # cleanup all bom files created in /tmp by `pkgutil`
-        for path in glob.glob(f"/tmp/{pkg}.boms*"):
+        for path in glob.glob(f"/tmp/{path}.boms*"):
             shutil.rmtree(path)
 
     form = []
diff --git a/jamf/package.py b/jamf/package.py
@@ -23,6 +23,7 @@
 from xml.etree import ElementTree as ET
 
 from .records import Categories
+from . import config
 
 # GLOBALS
 TMPDIR = os.environ.get('TMPDIR', '/tmp')
@@ -58,8 +59,8 @@ def find_name(self, name):
         :returns Package:
         """
         raise NotImplementedError()
-        if not name and not jssid and not path:
-            raise ValueError("must specify name, path, or ID")
+        #if not name and not jssid and not path:
+        #    raise ValueError("must specify name, path, or ID")
 
     def _find(self, key, value):
         """
@@ -617,44 +618,44 @@ def install_package(pkg, target='/'):
     """
     logger = logging.getLogger(__name__)
     path = pkg.path.absolute() if isinstance(pkg, Package) else pkg
-    self.log.info(f"installing package: {path}")
+    logger.info(f"installing package: {path}")
     cmd = ['/usr/sbin/installer', '-pkg', path, '-target', target]
     logger.debug(f"> sudo -n installer -pkg {path!r} -target {target!r}")
     subprocess.check_call(['/usr/bin/sudo', '-n'] + cmd)
 
 
-def jss_package_details(api, name=None):
-    """
-    :returns: detailed list of all packages in the JSS
-    """
-    # Each dict has the following keys:
-    # ['allow_uninstalled',              # <bool> likely the index value (would be cool if it could be indexed via modification)
-    #  'boot_volume_required',           # <bool> ? (universally: False)
-    #  'category',                       # <str>  name of category
-    #  'filename',                       # <str>  name of pkg file
-    #  'fill_existing_users',            # <bool> ? (universally: False)
-    #  'fill_user_template',             # <bool> ? (universally: False)
-    #  'id',                             # <int>  JSS id
-    #  'info',                           # <str>  contents of "Info" field
-    #  'install_if_reported_available',  # <str>  ? (universally: 'false')
-    #  'name',                           # <str>  name of package (typically same as filename)
-    #  'notes',                          # <str>  contents of "Notes" field
-    #  'os_requirements',                # <str>  os requirements? (universally: '')
-    #  'priority',                       # <int>  installation priority? (universally: 10)
-    #  'reboot_required',                # <bool> package requires reboot
-    #  'reinstall_option',               # <str>  ? (universally: "Do Not Reinstall")
-    #  'required_processor',             # <str>  processor limitation? (universally: 'None')
-    #  'send_notification',              # <bool> ? (universally: False)
-    #  'switch_with_package',            # <str>  ? (universally: 'Do Not Install')
-    #  'triggering_files']               # <dict> ? (universally: {})
-
-    # detailed list of every package (takes a long time)
-    pkgs = []
-    # isolating packages by name is handled by packages()
-    for pkg in packages(api, name):
-        details = api.get(f"packages/id/{pkg['id']}")
-        pkgs.append(details['package'])
-    return pkgs
+# def jss_package_details(api, name=None):
+#     """
+#     :returns: detailed list of all packages in the JSS
+#     """
+#     # Each dict has the following keys:
+#     # ['allow_uninstalled',              # <bool> likely the index value (would be cool if it could be indexed via modification)
+#     #  'boot_volume_required',           # <bool> ? (universally: False)
+#     #  'category',                       # <str>  name of category
+#     #  'filename',                       # <str>  name of pkg file
+#     #  'fill_existing_users',            # <bool> ? (universally: False)
+#     #  'fill_user_template',             # <bool> ? (universally: False)
+#     #  'id',                             # <int>  JSS id
+#     #  'info',                           # <str>  contents of "Info" field
+#     #  'install_if_reported_available',  # <str>  ? (universally: 'false')
+#     #  'name',                           # <str>  name of package (typically same as filename)
+#     #  'notes',                          # <str>  contents of "Notes" field
+#     #  'os_requirements',                # <str>  os requirements? (universally: '')
+#     #  'priority',                       # <int>  installation priority? (universally: 10)
+#     #  'reboot_required',                # <bool> package requires reboot
+#     #  'reinstall_option',               # <str>  ? (universally: "Do Not Reinstall")
+#     #  'required_processor',             # <str>  processor limitation? (universally: 'None')
+#     #  'send_notification',              # <bool> ? (universally: False)
+#     #  'switch_with_package',            # <str>  ? (universally: 'Do Not Install')
+#     #  'triggering_files']               # <dict> ? (universally: {})
+#
+#     # detailed list of every package (takes a long time)
+#     pkgs = []
+#     # isolating packages by name is handled by packages()
+#     for pkg in jamf_records(Packages, name):
+#         details = api.get(f"packages/id/{pkg['id']}")
+#         pkgs.append(details['package'])
+#     return pkgs
 
 
 def jss_packages(jss, name=None):
@@ -696,7 +697,6 @@ def installer_packages():
             b_info = plistlib.load(f)
         info[name] = {'pkgs': pkgs, 'folder': folder,
                       'build': b_info, 'name': name}
-    pprint.pprint(info)
 
 
 def pkgutil(*args):
diff --git a/jamf/setconfig.py b/jamf/setconfig.py
@@ -71,20 +71,9 @@ def parse(self, argv):
         return self.parser.parse_args(argv)
 
 def check_version():
-
-    try:
-        jamf_first, jamf_second, jamf_third = jamf.__version__.split(".")
-        min_first, min_second, min_third = min_jamf_version.split(".")
-
-        if ( int(jamf_first) <= int(min_first) and
-             int(jamf_second) <= int(min_second) and
-             int(jamf_third) < int(min_third)):
-             print(f"Your Version is: {jamf.__version__}, you need at least version {min_jamf_version} to run jctl.")
-             sys.exit()
-
-    except AttributeError:
-             print(f"Your Version is below 0.4.2, you need at least version {min_jamf_version} to run jctl.")
-             sys.exit()
+	if not jamf.version.check_version(min_jamf_version):
+		print(f"setconfig requires python-jamf {min_jamf_version} or newer.")
+		sys.exit()
 
 def setconfig(argv):
     logger = logging.getLogger(__name__)
@@ -107,7 +96,12 @@ def setconfig(argv):
         if args.path:
             config_path = args.path
         else:
-            config_path = self.default_pref
+            myplatform = platform.system()
+            if myplatform == "Darwin":
+                default_pref = jamf.config.MACOS_PREFS_TILDA
+            elif myplatform == "Linux":
+                default_pref = jamf.config.LINUX_PREFS_TILDA
+            config_path = default_pref
 
         if config_path[0] == '~':
             config_path = path.expanduser(config_path)
diff --git a/jamf/version.py b/jamf/version.py
@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+"""
+
+import os
+
+__all__ = (
+	'string',
+	'check_version'
+)
+
+def string():
+	try:
+		with open(os.path.dirname(__file__) + "/VERSION", "r", encoding="utf-8") as fh:
+			version = fh.read().strip()
+			if version:
+				return version
+	except:
+		pass
+	return "unknown (git checkout)"
+
+
+def check_version(min_version):
+	try:
+		jamf_1, jamf_2, jamf_3 = string().split(".")
+		min_1, min_2, min_3 = min_version.split(".")
+		if ( int(jamf_1) <= int(min_1) and
+			 int(jamf_2) <= int(min_2) and
+			 int(jamf_3) < int(min_3)):
+			return False
+	except AttributeError:
+		return False
+	return True
diff --git a/setup.py b/setup.py
@@ -1,19 +1,33 @@
 import setuptools
+import subprocess
+import os
 
-with open("README.md", "r") as fh:
+jctl_version = (
+    subprocess.run(["git", "describe", "--tags"], stdout=subprocess.PIPE)
+    .stdout.decode("utf-8")
+    .strip()
+)
+assert "." in jctl_version
+
+assert os.path.isfile("jamf/version.py")
+with open("jamf/VERSION", "w", encoding="utf-8") as fh:
+    fh.write(f"{jctl_version}\n")
+
+with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
 setuptools.setup(
     name="python-jamf",
-    version="0.6.5",
+    version=jctl_version,
     author="The University of Utah",
     author_email="mlib-its-mac@lists.utah.edu",
     description="Python wrapper for Jamf Pro API",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/univ-of-utah-marriott-library-apple/python-jamf",
     packages=setuptools.find_packages(),
-    package_data={'': ['*.json']},
+    package_data={'jamf': ['*.json', 'VERSION']},
+    include_package_data=True,
     entry_points={
         'console_scripts': ['jamfconfig=jamf.setconfig:main']
     },
