Configuring the tests to run in the CI/CD workflow with keys from GitHub secrets (#95)

* added and configured unit tests for 6 high priority endpoints

* added ApiTypes class

* removed extra space

* added configuration of CI/CD workflow

* fixed issue with JWT login method

* test ci/cd

* test

---------

Co-authored-by: AaronWDS <[email protected]>

Author: annahileta

.github/workflows/php.yml

@@ -0,0 +1,39 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run tests
+      env:
+          CLIENT_ID: ${{ secrets.CLIENT_ID }}
+          IMPERSONATED_USER_ID: ${{ secrets.IMPERSONATED_USER_ID }}
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          SIGNER_EMAIL: ${{ secrets.SIGNER_EMAIL }}
+          SIGNER_NAME: ${{ secrets.SIGNER_NAME }}
+      run: composer run-script test

.gitignore

@@ -25,6 +25,9 @@ tmtags
 Thumbs.db
 Desktop.ini
 
+# add exception for workflow folder
+!.github
+
 # ignore Composer downloads
 /vendor/*
 /Quick_ACG/vendor/*

Dockerfile

@@ -60,7 +60,7 @@ COPY src src/
 COPY --from=composer_stage /usr/bin/composer /usr/bin/composer
 COPY composer.json /var/www/html/
 # This are production settings, I'm running with 'no-dev', adjust accordingly 
-# if you need it
+# if you need it  
 RUN composer install
 
 CMD ["php-fpm"]

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE. 

composer.json

@@ -15,16 +15,18 @@
         ],
         "post-update-cmd": [
             "@code-sniffer"
-        ]
+        ],
+        "test": "./vendor/bin/phpunit --verbose tests"
     },
+    "description": "DocuSign PHP launcher",
     "require": {
-        "docusign/admin-client": "1.1.0",
-        "docusign/click-client": "1.2.2",
-        "docusign/esign-client": "6.8.0",
-        "docusign/rooms-client": "2.0.0",
-        "docusign/monitor-client": "1.1.0",
-        "twig/twig": "3.4.3",
-        "league/oauth2-client": "2.6.1",
+        "docusign/admin-client": "^1.1.0",
+        "docusign/click-client": "^1.2.2",
+        "docusign/esign-client": "^6.8.0",
+        "docusign/rooms-client": "^2.0.0",
+        "docusign/monitor-client": "^1.1.0",
+        "twig/twig": "^3.4.3",
+        "league/oauth2-client": "^2.6.1",
         "ext-json": "*",
         "guzzlehttp/guzzle": "7.4.5",
         "firebase/php-jwt": "5.5.1",

composer.lock

@@ -44,10 +44,15 @@ public function createController(): void
         # 2. Call the worker method
         # More data validation would be a good idea here
         # Strip anything other than characters listed
+        $pdfDoc = $GLOBALS['DS_CONFIG']['doc_pdf'];
+        $docxDoc = $GLOBALS['DS_CONFIG']['doc_docx'];
+
         $envelopeResponse = SigningViaEmailService::signingViaEmail(
             $this->args,
             $this->clientService,
-            $this::DEMO_DOCS_PATH
+            $this::DEMO_DOCS_PATH,
+            $docxDoc,
+            $pdfDoc
         );
 
         if ($envelopeResponse) {

src/Controllers/Examples/eSignature/EG002SigningViaEmail.php

@@ -40,10 +40,12 @@ public function createController(): void
         # 1. Call the worker method
         # More data validation would be a good idea here
         # Strip anything other than characters listed
+        $pdfDoc = $GLOBALS['DS_CONFIG']['doc_pdf'];
         $envelopeIdAndReturnUrl = EmbeddedSigningService::worker(
             $this->args,
             $this->clientService,
-            self::DEMO_DOCS_PATH
+            self::DEMO_DOCS_PATH,
+            $pdfDoc
         );
 
         if ($envelopeIdAndReturnUrl) {