0.4.0: Bump python support (#21)

Author: cognifloyd

.github/workflows/tox.yaml

@@ -0,0 +1,82 @@
+name: Tox CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.8"
+
+    - name: Install tox
+      run: pip install --user tox
+
+    - name: Lint
+      run: tox -e lint
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tox
+      run: pip install --user tox
+
+    - name: Select tox env
+      id: tox-env
+      run: echo tox-env=py${{ matrix.python-version }} | tr -d '.' >> ${GITHUB_OUTPUT}
+
+    - name: Prepare Integration 
+      run: sudo -E ./scripts/prepare-integration.sh
+
+    - name: Test
+      run: sudo -E -- $(which tox) -e ${{ steps.tox-env.outputs.tox-env }}
+
+  set_merge_ok:
+    name: Set Merge OK
+    if: always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled')
+    needs:
+    - lint
+    - test
+    outputs:
+      merge_ok: ${{ steps.set_merge_ok.outputs.merge_ok }}
+    runs-on: ubuntu-latest
+    steps:
+    - id: set_merge_ok
+      run: echo 'merge_ok=true' >> ${GITHUB_OUTPUT}
+
+  merge_ok:
+    name: Merge OK
+    if: always()
+    needs:
+    - set_merge_ok
+    runs-on: ubuntu-latest
+    steps:
+    - run: |
+        merge_ok="${{ needs.set_merge_ok.outputs.merge_ok }}"
+        if [[ "${merge_ok}" == "true" ]]; then
+          echo "Merge OK"
+          exit 0
+        else
+          echo "Merge NOT OK"
+          exit 1
+        fi

.travis.yml

@@ -1,6 +1,4 @@
-# PAM authentication plugin for StackStorm Community and Enterprise edition
-
-[![Build Status](https://travis-ci.org/StackStorm/st2-auth-backend-pam.svg?branch=master)](https://travis-ci.org/StackStorm/st2-auth-backend-pam) [![IRC](https://img.shields.io/irc/%23stackstorm.png)](http://webchat.freenode.net/?channels=stackstorm)
+# PAM authentication plugin for StackStorm
 
 PAM authentication backend allows users to authenticate against the PAM (Pluggable Authentication
 Modules) on the system where ``st2auth`` service is running.

README.md

@@ -1,22 +1,17 @@
 [MESSAGES CONTROL]
 # C0111 Missing docstring 
 # I0011 Warning locally suppressed using disable-msg
-# I0012 Warning locally suppressed using disable-msg
-# W0704 Except doesn't do anything Used when an except clause does nothing but "pass" and there is no "else" clause
-# W0142 Used * or * magic* Used when a function or method is called using *args or **kwargs to dispatch arguments.
 # W0212 Access to a protected member %s of a client class
-# W0232 Class has no __init__ method Used when a class has no __init__ method, neither its parent classes.
 # W0613 Unused argument %r Used when a function or method argument is not used.
 # W0702 No exception's type specified Used when an except clause doesn't specify exceptions type to catch.
-# R0201 Method could be a function
 # W0614 Unused import XYZ from wildcard import
 # R0914 Too many local variables
 # R0912 Too many branches
 # R0915 Too many statements
 # R0913 Too many arguments
 # R0904 Too many public methods
 # E0211: Method has no argument
-disable=C0103,C0111,I0011,I0012,W0704,W0142,W0212,W0232,W0613,W0702,R0201,W0614,R0914,R0912,R0915,R0913,R0904,R0801
+disable=C0103,C0111,I0011,W0212,W0613,W0702,W0614,R0914,R0912,R0915,R0913,R0904,R0801
 
 [TYPECHECK]
 # Note: This modules are manipulated during the runtime so we can't detect all the properties during

lint-configs/python/.pylintrc

@@ -1 +0,0 @@
-six

requirements.txt

@@ -21,7 +21,8 @@ create_user() {
 }
 
 # mkpasswd requires whois package
-apt-get update
-apt-get install -y whois
+apt-get install -y whois pamtester
 
 create_user
+
+echo ${TESTPASSWD} | pamtester -v login ${TESTUSER} authenticate

scripts/travis/prepare-integration.sh scripts/prepare-integration.sh

@@ -27,10 +27,15 @@
 version = parse_version_string(INIT_FILE)
 install_reqs, dep_links = fetch_requirements(REQUIREMENTS_FILE)
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 setup(
     name='st2-auth-backend-pam',
     version=version,
     description='PAM authentication plugin for StackStorm.',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author='StackStorm, Inc.',
     author_email='[email protected]',
     url='https://github.com/StackStorm/st2-auth-backend-pam',
@@ -43,20 +48,21 @@
         'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Intended Audience :: Developers',
         'Environment :: Console',
     ],
+    python_requires='>=3.8',
     platforms=['Any'],
     scripts=[],
     provides=['st2auth_pam_backend'],
     packages=find_packages(),
     include_package_data=True,
     install_requires=install_reqs,
     dependency_links=dep_links,
-    test_suite='tests',
     entry_points={
         'st2auth.backends.backend': [
             'pam = st2auth_pam_backend.pam_backend:PAMAuthenticationBackend',

scripts/travis/build.sh

@@ -21,4 +21,4 @@
     'PAMAuthenticationBackend'
 ]
 
-__version__ = '0.3.0'
+__version__ = '0.4.0'

setup.py

@@ -25,8 +25,6 @@
 from ctypes import memmove
 from ctypes.util import find_library
 
-from six.moves import range  # pylint: disable=import-error,redefined-builtin
-
 LIBPAM = CDLL(find_library('pam'))
 LIBC = CDLL(find_library('c'))
 

st2auth_pam_backend/__init__.py

@@ -1,8 +1,6 @@
-mock==3.0.5 ; python_version == '2.7'
-mock==4.0.3 ; python_version >= '3.6'
-nose>=1.3.7
+flake8==7.0.0
+mock==5.1.0
 pep8==1.7.1
-pylint<2 ; python_version == '2.7'
-pylint==2.8.2 ; python_version >= '3.6'
-st2flake8==0.1.0
-unittest2
+pylint~=3.1.0
+pytest
+st2flake8

st2auth_pam_backend/pam_ffi.py

@@ -14,19 +14,19 @@
 # limitations under the License.
 
 import mock
-import unittest2
+import unittest
 
 from st2auth_pam_backend import pam_backend
 
 
-class PAMBackendAuthenticationTest(unittest2.TestCase):
+class PAMBackendAuthenticationTest(unittest.TestCase):
     @mock.patch('os.geteuid')
     def test_non_root_user(self, mock_get_euid):
         # non root
         mock_get_euid.return_value = 100
 
         expected_msg = 'st2auth process needs to run as "root"'
-        self.assertRaisesRegexp(ValueError, expected_msg,
+        self.assertRaisesRegex(ValueError, expected_msg,
                                 pam_backend.PAMAuthenticationBackend)
 
         # non root, but check for root is disabled
@@ -37,16 +37,14 @@ def test_non_root_user(self, mock_get_euid):
         mock_get_euid.return_value = 0
         pam_backend.PAMAuthenticationBackend()
 
-    # See scrips/travis/prepare-integration.sh for right username + password.
+    # See scrips/prepare-integration.sh for right username + password.
     @mock.patch('os.geteuid', mock.Mock(return_value=0))
     def test_good_password(self):
         pam = pam_backend.PAMAuthenticationBackend()
-        self.assertEqual(pam.authenticate('pammer', 'spammer'), True,
-                         'Valid credentials should return True.')
+        assert pam.authenticate('pammer', 'spammer'), 'Valid credentials should return True.'
 
-    # See scrips/travis/prepare-integration.sh for right username + password.
+    # See scrips/prepare-integration.sh for right username + password.
     @mock.patch('os.geteuid', mock.Mock(return_value=0))
     def test_bad_password(self):
         pam = pam_backend.PAMAuthenticationBackend()
-        self.assertEqual(pam.authenticate('pammer', 'oumpalumpa'), False,
-                         'Invalid credentials should return False.')
+        assert not pam.authenticate('pammer', 'oumpalumpa'), 'Invalid credentials should return False.'

test-requirements.txt

@@ -1,21 +1,21 @@
 [tox]
-envlist = py27,py36,py38,lint
+envlist = py38,py39,py310,py311,lint
 
 [testenv]
-deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
-
-[testenv:py27]
-basepython = python2.7
-commands = python setup.py test
-
-[testenv:py36]
-basepython = python3.6
-commands = python setup.py test
+deps = -r{toxinidir}/test-requirements.txt
+commands = pytest -l --log-level=DEBUG --color=yes --show-capture=all
 
 [testenv:py38]
 basepython = python3.8
-commands = python setup.py test
+
+[testenv:py39]
+basepython = python3.9
+
+[testenv:py310]
+basepython = python3.10
+
+[testenv:py311]
+basepython = python3.11
 
 [testenv:lint]
 commands = flake8 --config ./lint-configs/python/.flake8 st2auth_pam_backend/