Add Secrets SDK with Rust keyring bindings

.github/workflows/sdk-build.yml

@@ -13,41 +13,41 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
     env:
       OS: ${{ matrix.os }}
       PYTHON: ${{ matrix.python-version }}
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 ./src --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 ./src --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
-      run: |
-        coverage run -m pytest ./tests/unit
-    - name: Generate a coverage xml file
-      run: |
-        coverage xml
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
-      if: ${{ matrix.python-version == '3.11' }}
-      with:
-        directory: ./
-        env_vars: OS,PYTHON
-        fail_ci_if_error: true
-        files: ./coverage.xml
-        flags: unittests
-        name: codecov-umbrella
-        verbose: true
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 ./src --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 ./src --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          coverage run -m pytest ./tests/unit
+      - name: Generate a coverage xml file
+        run: |
+          coverage xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        if: ${{ matrix.python-version == '3.12' }}
+        with:
+          directory: ./
+          env_vars: OS,PYTHON
+          fail_ci_if_error: true
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          verbose: true

.github/workflows/secrets-sdk.yml

@@ -0,0 +1,144 @@
+# This file is autogenerated by maturin v1.3.1
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: Secrets SDK CI
+
+on:
+  push:
+    paths:
+      - "src/secrets/**"
+      - ".github/workflows/secrets-sdk.yml"
+  pull_request:
+    paths:
+      - "src/secrets/**"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [x86_64, x86, aarch64, armv7, s390x]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Set environment variables
+        run: src/secrets/scripts/configure-cross.sh ${{ matrix.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --skip-auditwheel
+          sccache: "true"
+          manylinux: auto
+          docker-options: -e PKG_CONFIG_SYSROOT_DIR -e PKG_CONFIG_PATH
+          working-directory: src/secrets
+          before-script-linux: |
+            if command -v yum &> /dev/null; then
+              yum update && yum install -y libsecret-devel.${{ env.CROSS_DEB_ARCH }} pkgconfig
+            else
+              dpkg --add-architecture ${{ env.CROSS_DEB_ARCH }}
+              sed -i "s/deb /deb [arch=amd64] /g" /etc/apt/sources.list
+              echo "deb [arch=${{ env.CROSS_DEB_ARCH }}] http://ports.ubuntu.com/ubuntu-ports/ jammy main universe" >> /etc/apt/sources.list
+              echo "deb [arch=${{ env.CROSS_DEB_ARCH }}] http://ports.ubuntu.com/ubuntu-ports/ jammy-updates main universe" >> /etc/apt/sources.list
+              apt-get update && apt-get install -y libsecret-1-dev:${{ env.CROSS_DEB_ARCH }} pkg-config
+            fi
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: src/secrets/dist
+
+  windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        target: [x64, x86, aarch64]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        if: ${{ matrix.target != 'aarch64' }}
+        with:
+          python-version: "3.10"
+          architecture: ${{ matrix.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist
+          sccache: "true"
+          working-directory: src/secrets
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: src/secrets/dist
+
+  macos:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        target: [x86_64, aarch64]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist
+          sccache: "true"
+          working-directory: src/secrets
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: src/secrets/dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+          working-directory: src/secrets
+      - name: Upload sdist
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: src/secrets/dist
+
+  # release:
+  #   name: Release
+  #   runs-on: ubuntu-latest
+  #   if: ${{ startsWith(github.ref, 'refs/tags/') }}
+  #   needs: [linux, windows, macos, sdist]
+  #   steps:
+  #     - uses: actions/download-artifact@v3
+  #       with:
+  #         name: wheels
+  #     - name: Publish to PyPI
+  #       uses: PyO3/maturin-action@v1
+  #       env:
+  #         MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+  #       with:
+  #         command: upload
+  #         args: --non-interactive --skip-existing *
+  #         working-directory: src/secrets

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "editor.formatOnSave": true,
     "python.formatting.provider": "black",
+    "rust-analyzer.linkedProjects": ["./src/secrets/Cargo.toml"],
     "[python]": {
         "editor.codeActionsOnSave": {
             "source.organizeImports": true

CHANGELOG.md

@@ -4,12 +4,17 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil
 
 ## Recent Changes
 
-- Bug: Fixed profile merge order to match Node.js SDK 
-- Feature: Added method to load profile properties from environment variables
-- Bugfix: Fixed exception handling in session.py [#213] (https://github.com/zowe/zowe-client-python-sdk/issues/213)
-- Feature: Added a CredentialManager class to securely retrieve values from credentials and manage multiple credential entries on Windows [#134](https://github.com/zowe/zowe-client-python-sdk/issues/134)
-- Feature: Added method to Save profile properties to zowe.config.json file [#73](https://github.com/zowe/zowe-client-python-sdk/issues/73)
-- Feature: Added method to Save secure profile properties to vault [#72](https://github.com/zowe/zowe-client-python-sdk/issues/72)
-- Bugfix: Fixed issue for datasets and jobs with special characters in URL [#211] (https://github.com/zowe/zowe-client-python-sdk/issues/211)
-- Feature: Added method to load profile properties from environment variables
-- BugFix: Validation of zowe.config.json file matching the schema [#192](https://github.com/zowe/zowe-client-python-sdk/issues/192)
+### Enhancements
+
+- Added method to save secure profile properties to vault [#72](https://github.com/zowe/zowe-client-python-sdk/issues/72)
+- Added method to save profile properties to zowe.config.json file [#73](https://github.com/zowe/zowe-client-python-sdk/issues/73)
+- Added CredentialManager class to securely retrieve values from credentials and manage multiple credential entries on Windows [#134](https://github.com/zowe/zowe-client-python-sdk/issues/134)
+- Added method to load profile properties from environment variables [#136](https://github.com/zowe/zowe-client-python-sdk/issues/136)
+- Added validation of zowe.config.json file matching the schema [#192](https://github.com/zowe/zowe-client-python-sdk/issues/192)
+- Added Secrets SDK for storing client secrets in OS keyring [#208](https://github.com/zowe/zowe-client-python-sdk/issues/208)
+
+### Bug Fixes
+
+- Fixed profile merge order to match Node.js SDK [#190](https://github.com/zowe/zowe-client-python-sdk/issues/190)
+- Fixed issue for datasets and jobs with special characters in URL [#211](https://github.com/zowe/zowe-client-python-sdk/issues/211)
+- Fixed exception handling in session.py [#213](https://github.com/zowe/zowe-client-python-sdk/issues/213)

docs/requirements.txt

@@ -1,5 +1,5 @@
 sphinx_rtd_theme>=0.5.1
-sphinxcontrib-spelling==5.4.0
+sphinxcontrib-spelling==8.0.0
 -e ./src/core
 -e ./src/zos_console
 -e ./src/zos_files

requirements.txt

@@ -5,19 +5,19 @@ colorama==0.4.4
 commentjson==0.9.0
 coverage==5.4
 deepmerge==1.1.0
-flake8==3.8.4
+flake8==5.0.0
 idna==2.10
-importlib-metadata==3.6.0
+importlib-metadata==3.6.0;python_version<"3.8"
 isort
 jsonschema==4.17.3
-keyring
 lxml==4.9.3
-mccabe==0.6.1
+maturin
+mccabe==0.7.0
 nose2==0.10.0
-pycodestyle==2.6.0
+pycodestyle==2.9.0
 pydocstyle==5.1.1
 pyfakefs
-pyflakes==2.2.0
+pyflakes==2.5.0
 pylama==7.7.1
 pytest==7.1.2
 python-decouple==3.4
@@ -30,7 +30,8 @@ Unidecode==1.2.0
 urllib3==1.26.18
 wheel
 zipp==3.4.0
--e ./src/core
+-e ./src/core[secrets]
+-e ./src/secrets
 -e ./src/zos_console
 -e ./src/zos_files
 -e ./src/zos_jobs

src/core/setup.py

@@ -2,8 +2,9 @@
 
 from setuptools import find_namespace_packages, setup
 
-sys.path.append("..")
+sys.path.insert(0, "..")
 from _version import __version__
+from setup import resolve_sdk_dep
 
 setup(
     name="zowe_core_for_zowe_sdk",
@@ -18,6 +19,16 @@
         "Programming Language :: Python :: 3.7",
         "License :: OSI Approved :: Eclipse Public License 2.0 (EPL-2.0)",
     ],
-    install_requires=["requests", "urllib3", "pyyaml", "commentjson"],
+    install_requires=[
+        "commentjson",
+        "deepmerge",
+        "jsonschema",
+        "pyyaml",
+        "requests",
+        "urllib3",
+    ],
+    extras_require={
+        "secrets": [resolve_sdk_dep("secrets", "~=0.1.0")]
+    },
     packages=find_namespace_packages(include=["zowe.*"]),
 )