Merge pull request #51 from phoenixnap/release/v2.0.0

Release/v2.0.0

Author: valerioponte

.github/workflows/_common.yml

@@ -20,19 +20,19 @@ jobs:
         with:
           package-name: ${{ inputs.package-name }}
   test:
-    name: Test ${{ inputs.package-name }}
+    name: Test ${{ inputs.package-name }} py v ${{ matrix.python-version }}
     runs-on: ubuntu-20.04
     needs:
       - lint
     services:
       mockserver:
-        image: mockserver/mockserver:5.13.0
+        image: mockserver/mockserver:5.15.0
         ports:
           - 1080:1080
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ '3.6', '3.11' ]
+        python-version: [ '3.7', '3.12' ]
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/workflows/composite/test-sdk
@@ -41,4 +41,4 @@ jobs:
           test-dir: tests
           test-file: ${{ inputs.test-file }}
           test-report-dir: tests/test-reports
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python-version }}

.github/workflows/_publish_all.yml

@@ -101,4 +101,26 @@ jobs:
       PYPI_API_KEY: ${{ secrets.PYPI_API_KEY }}
     with:
       dry_run: ${{ inputs.dry_run }}
-      package_to_publish: pnap_location_api
+      package_to_publish: pnap_location_api
+
+  publish-payments-api:
+    name: Publish Payments API
+    needs:
+      - validate-all
+    uses: ./.github/workflows/_publish.yml
+    secrets:
+      PYPI_API_KEY: ${{ secrets.PYPI_API_KEY }}
+    with:
+      dry_run: ${{ inputs.dry_run }}
+      package_to_publish: pnap_payments_api
+
+  publish-invoicing-api:
+    name: Publish Invoicing API
+    needs:
+      - validate-all
+    uses: ./.github/workflows/_publish.yml
+    secrets:
+      PYPI_API_KEY: ${{ secrets.PYPI_API_KEY }}
+    with:
+      dry_run: ${{ inputs.dry_run }}
+      package_to_publish: pnap_invoicing_api

.github/workflows/composite/generate-sdk/action.yml

@@ -20,12 +20,34 @@ runs:
     - name: Install openapi-generator-cli
       shell: bash
       run: npm install -g @openapitools/openapi-generator-cli
+    - name: Cleanup existing files
+      shell: bash
+      run: |
+        echo "Moving version.py file out..."
+        mv ./${{ inputs.package-name }}/${{ inputs.package-name }}/version.py ./version.py
+
+        echo "Cleaning up ${{ inputs.package-name }}..."
+        rm -rf ./${{ inputs.package-name }}/*
+
+        echo "Re-creating folder inside ${{ inputs.package-name }}..."
+        mkdir ./${{ inputs.package-name }}/${{ inputs.package-name }}
+
+        echo "Moving version.py file back in..."
+        mv ./version.py ./${{ inputs.package-name }}/${{ inputs.package-name }}/version.py
     - name: Download spec files
       shell: bash
       run: wget ${{ inputs.spec-link }} -O ./${{ inputs.package-name }}/${{ inputs.package-name }}.spec.yaml
     - name: Generate API
       shell: bash
-      run: openapi-generator-cli generate -i ${{ inputs.spec-link }} -c openapi-generator-config.yaml -o=${{ inputs.package-name }} --additional-properties packageName=${{ inputs.package-name }}
+      run: |
+        version=$(./extract-version.sh ./${{ inputs.package-name }}/${{ inputs.package-name }}/version.py)
+
+        openapi-generator-cli generate \
+        -i ${{ inputs.spec-link }} \
+        -c openapi-generator-config.yaml \
+        -o=${{ inputs.package-name }} \
+        --additional-properties packageName=${{ inputs.package-name }} \
+        --additional-properties packageVersion=$version
     - name: Upload Artifacts
       uses: actions/upload-artifact@v3
       with:

.github/workflows/composite/setup-python/action.yml

@@ -4,17 +4,11 @@ inputs:
   python-version: 
     description: 'Version of Python to setup.'
     required: false
-    default: '3.6'
+    default: '3.7'
 runs:
   using: "composite"
   steps:
     - name: Setup Python
       uses: actions/setup-python@v4
       with:
-        python-version: ${{ inputs.python-version }}
-
-    # Suggested by https://stackoverflow.com/a/70431656 - script will complete the setup for pip, since it's incomplete for some versions.
-    - name: Fix PIP (for non-3.6 python)
-      if: inputs.python-version != 3.6
-      shell: bash
-      run: curl -sS https://bootstrap.pypa.io/get-pip.py | python${{ inputs.python-version }}
+        python-version: ${{ inputs.python-version }}

.github/workflows/generate-all.yml

@@ -70,7 +70,19 @@ jobs:
     with:
       spec-link: https://developers.phoenixnap.com/portals/api/sites/phoenixnap-prod-developerportal/liveportal/apis/bmc-location/download_spec
       package-name: pnap_location_api
-
+  generate-invoicingapi:
+    needs: prerequisite
+    uses: ./.github/workflows/_generate.yml
+    with:
+      spec-link: https://developers.phoenixnap.com/portals/api/sites/phoenixnap-prod-developerportal/liveportal/apis/invoicing/download_spec
+      package-name: pnap_invoicing_api
+  generate-paymentsapi:
+    needs: prerequisite
+    uses: ./.github/workflows/_generate.yml
+    with:
+      spec-link: https://developers.phoenixnap.com/portals/api/sites/phoenixnap-prod-developerportal/liveportal/apis/payments/download_spec
+      package-name: pnap_payments_api
+  
   # Push generated code
   push-changes:
     name: Push Changes
@@ -84,23 +96,52 @@ jobs:
       - generate-tagapi
       - generate-networkstorageapi
       - generate-locationapi
+      - generate-invoicingapi
+      - generate-paymentsapi
+    outputs:
+      CHANGES_FOUND: ${{ steps.commit-step.outputs.CHANGES_FOUND }}
     steps:
       - name: Check out the repo
         uses: actions/checkout@v3
+      - name: Clean up modules
+        run: |
+          rm -rf ./pnap_audit_api \
+           ./pnap_bmc_api \
+           ./pnap_ip_api \
+           ./pnap_location_api \
+           ./pnap_network_api \
+           ./pnap_network_storage_api \
+           ./pnap_rancher_solution_api \
+           ./pnap_tag_api \
+           ./pnap_payment_api \
+           ./pnap_invoice_api
       - name: Download Artifacts
         uses: actions/download-artifact@v3
       - name: Move spec files
         run: |
           find . -type f -name "*.spec.yaml" -not -path "./specs/*" -print0 | xargs -0 mv -ft ./specs/
-      - name: Add and Commit files
+      - id: commit-step
+        name: Add and Commit files
         run: |
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
           git add -A
 
-          if test "$(git status --porcelain=v1 2>/dev/null | wc -l)" -gt "0" ; then git commit -m "Add changes"; else echo No changes found; fi
+          if test "$(git status --porcelain=v1 2>/dev/null | wc -l)" -gt "0" ;
+          then 
+            git commit -m "Add changes";
+            echo "CHANGES_FOUND=true" >> "$GITHUB_OUTPUT";
+          else 
+            echo No changes found;
+          fi
       - name: Push changes
         uses: ad-m/github-push-action@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ github.ref }}
+          branch: ${{ github.ref }}
+
+  validate-all:
+    if: ${{ needs.push-changes.outputs.CHANGES_FOUND }}
+    needs:
+      - push-changes
+    uses: ./.github/workflows/validate-all.yml

.github/workflows/validate-all.yml

@@ -47,6 +47,16 @@ jobs:
     with:
       package-name: pnap_location_api
       test-file: pnap_location_api_test.py
+  build-and-test-invoicingapi:
+    uses: ./.github/workflows/_common.yml
+    with:
+      package-name: pnap_invoicing_api
+      test-file: pnap_invoicing_api_test.py
+  build-and-test-paymentsapi:
+    uses: ./.github/workflows/_common.yml
+    with:
+      package-name: pnap_payments_api
+      test-file: pnap_payments_api_test.py
 
   publish-test-results:
     name: Publish Test Results
@@ -59,6 +69,8 @@ jobs:
       - build-and-test-tagapi
       - build-and-test-networkstorageapi
       - build-and-test-locationapi
+      - build-and-test-invoicingapi
+      - build-and-test-paymentsapi
     runs-on: ubuntu-20.04
     if: always()
     steps:

extract-version.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+filename="$1"
+
+# Define the regex pattern
+regex='VERSION = "(.*)"'
+
+# Read the contents of the file
+contents="$(cat $filename)"
+
+# Check if the contents match the regex
+if [[ $contents =~ $regex ]]; then
+    # Print the matched version
+    echo "${BASH_REMATCH[1]}"
+else
+    # Print an error message and exit with an error code
+    echo "Couldn't find a match for ($regex) in $filename."
+    exit 1
+fi

openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "6.1.0"
+    "version": "7.2.0"
   }
 }

pnap_audit_api/.github/workflows/python.yml

@@ -0,0 +1,38 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: pnap_audit_api Python package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    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 flake8 pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          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=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          pytest

pnap_audit_api/.openapi-generator/FILES

@@ -1,3 +1,4 @@
+.github/workflows/python.yml
 README.md
 docs/Error.md
 docs/Event.md
@@ -7,15 +8,15 @@ pnap_audit_api/__init__.py
 pnap_audit_api/api/__init__.py
 pnap_audit_api/api/events_api.py
 pnap_audit_api/api_client.py
-pnap_audit_api/apis/__init__.py
+pnap_audit_api/api_response.py
 pnap_audit_api/configuration.py
 pnap_audit_api/exceptions.py
-pnap_audit_api/model/__init__.py
-pnap_audit_api/model/error.py
-pnap_audit_api/model/event.py
-pnap_audit_api/model/user_info.py
-pnap_audit_api/model_utils.py
 pnap_audit_api/models/__init__.py
+pnap_audit_api/models/error.py
+pnap_audit_api/models/event.py
+pnap_audit_api/models/user_info.py
+pnap_audit_api/py.typed
 pnap_audit_api/rest.py
+pyproject.toml
 requirements.txt
 setup.py