GitHub workflows

.github/dependabot.yml

@@ -37,10 +37,32 @@ updates:
       time: "08:00"
 
   - package-ecosystem: "nuget"
-    directory: "/client-samples/dotnet/rest"
+    directory: "/client-samples/dotnet/rest/api-template"
     commit-message:
       prefix: "nuget-rest"
     schedule:
       interval: "monthly"
       day: "monday"
       time: "08:00"
+
+  - package-ecosystem: "nuget"
+    directory: "/client-samples/dotnet/rest/api-template.tests"
+    commit-message:
+      prefix: "nuget-rest-tests"
+    schedule:
+      interval: "monthly"
+      day: "monday"
+      time: "08:00"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    commit-message:
+      prefix: "github-actions"
+    schedule:
+      interval: "monthly"
+      day: "monday"
+      time: "08:00"
+    groups:
+      actions:
+        patterns:
+          - "actions/*"

.github/workflows/dotnet-ci.yml → .github/workflows/dotnet-rest-ci.yml

@@ -1,25 +1,27 @@
-name: .NET CI
+name: .NET REST Tests
 
 on:
   push:
     branches: [ "main" ]
     paths: 
-      - 'client-samples/dotnet/**'
+      - 'client-samples/dotnet/rest/**'
+      - '.github/workflows/dotnet-rest-ci.yml'
   pull_request:
     branches: [ "main" ]
     paths: 
-      - 'client-samples/dotnet/**'
+      - 'client-samples/dotnet/rest/**'
+      - '.github/workflows/dotnet-rest-ci.yml'
 jobs:
-    dotnet-checkout-and-test:
+    dotnet-rest-ci:
         runs-on: windows-latest
         defaults:
             run:
                 working-directory: ./client-samples/dotnet/rest
         steps:
         - name: Checkout repository
-          uses: actions/checkout@v4
+          uses: actions/checkout@v5
         - name: Setup .NET
-          uses: actions/setup-dotnet@v3
+          uses: actions/setup-dotnet@v5
           with:
             dotnet-version: 9.0.x
         - name: Restore dependencies

.github/workflows/java-base-ci.yml

@@ -0,0 +1,33 @@
+name: Reusable Java CI Workflow
+
+on:
+  workflow_call:
+    inputs:
+      working-directory:
+        required: true
+        type: string
+        description: 'Path to the directory containing the Java code to test'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java-version: ['11', '17', '21']
+    defaults:
+      run:
+        working-directory: ${{ inputs.working-directory }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Set up JDK
+        uses: actions/setup-java@v5
+        with:
+          java-version: ${{ matrix.java-version }}
+          distribution: 'zulu'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Gradle Build
+        run: ./gradlew build
+      - name: Gradle Test
+        run: ./gradlew test

.github/workflows/java-rest-ci.yml

@@ -0,0 +1,22 @@
+name: Java REST Tests
+
+on:
+  push:
+    branches: [ "main" ]
+    paths: 
+      - 'client-samples/java/rest/**'
+      - '.github/workflows/java-rest-ci.yml'
+      - '.github/workflows/java-base-ci.yml'
+  pull_request:
+    branches: [ "main" ]
+    paths: 
+      - 'client-samples/java/rest/**'
+      - '.github/workflows/java-rest-ci.yml'
+      - '.github/workflows/java-base-ci.yml'
+
+jobs:
+  # REST tests
+  rest-ci:
+    uses: ./.github/workflows/java-base-ci.yml
+    with:
+      working-directory: ./client-samples/java/rest

.github/workflows/java-websockets-ci.yml

@@ -0,0 +1,22 @@
+name: Java WebSockets Tests
+
+on:
+  push:
+    branches: [ "main" ]
+    paths: 
+      - 'client-samples/java/websockets/**'
+      - '.github/workflows/java-websockets-ci.yml'
+      - '.github/workflows/java-base-ci.yml'
+  pull_request:
+    branches: [ "main" ]
+    paths: 
+      - 'client-samples/java/websockets/**'
+      - '.github/workflows/java-websockets-ci.yml'
+      - '.github/workflows/java-base-ci.yml'
+
+jobs:
+  # WebSockets tests
+  websockets-ci:
+    uses: ./.github/workflows/java-base-ci.yml
+    with:
+      working-directory: ./client-samples/java/websockets

.github/workflows/python-ci.yml → .github/workflows/python-base-ci.yml

@@ -1,31 +1,27 @@
-name: Python Tests
+name: Reusable Python CI Workflow
 
 on:
-  push:
-    branches: [ "main" ]
-    paths:
-      - "client-samples/python/**"
-  pull_request:
-    branches: [ "main" ]
-    paths:
-      - "client-samples/python/**"
+  workflow_call:
+    inputs:
+      working-directory:
+        required: true
+        type: string
+        description: 'Path to the directory containing the Python code to test'
+
 jobs:
-  python-checkout-and-test:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
-        working-directory:
-          - ./client-samples/python/rest
-          - ./client-samples/python/websockets
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
     defaults:
       run:
-        working-directory: ${{ matrix.working-directory }}
+        working-directory: ${{ inputs.working-directory }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Upgrade pip
@@ -37,4 +33,4 @@ jobs:
       - name: Run pytest
         run: pytest tests/
       - name: Run black check (linting)
-        run: black --check .
+        run: black --check .

.github/workflows/python-rest-ci.yml

@@ -0,0 +1,22 @@
+name: Python REST Tests
+
+on:
+  push:
+    branches: [ "main" ]
+    paths:
+      - "client-samples/python/rest/**"
+      - ".github/workflows/python-rest-ci.yml"
+      - ".github/workflows/python-base-ci.yml"
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - "client-samples/python/rest/**"
+      - ".github/workflows/python-rest-ci.yml"
+      - ".github/workflows/python-base-ci.yml"
+
+jobs:
+  # REST tests
+  rest-ci:
+    uses: ./.github/workflows/python-base-ci.yml
+    with:
+      working-directory: ./client-samples/python/rest

.github/workflows/python-websockets-ci.yml

@@ -0,0 +1,22 @@
+name: Python WebSockets Tests
+
+on:
+  push:
+    branches: [ "main" ]
+    paths:
+      - "client-samples/python/websockets/**"
+      - ".github/workflows/python-websockets-ci.yml"
+      - ".github/workflows/python-base-ci.yml"
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - "client-samples/python/websockets/**"
+      - ".github/workflows/python-websockets-ci.yml"
+      - ".github/workflows/python-base-ci.yml"
+
+jobs:
+  # WebSockets tests
+  websockets-ci:
+    uses: ./.github/workflows/python-base-ci.yml
+    with:
+      working-directory: ./client-samples/python/websockets

client-samples/python/rest/README.md

@@ -7,26 +7,33 @@ It uses the following libraries:
 It requires some simple security configuration to enable you to authenticate to the platform.
 
 ## Requirements
-- Python 3.9+
+- Python 3.10+
 - A client application on Morgan Stanley Azure AD tenant. Please talk to your contact at Morgan Stanley to set this up.
 - A self-signed public/private key pair. Please see the client setup guide for instructions to generate this.
 - The thumbprint (also known as fingerprint) for your certificate. 
   - You can retrieve this from your cert using OpenSSL with the following command: `openssl x509 -noout -fingerprint -in cert.cer`
 
 ## Configuration
 Create a file, config.json, with the following properties:
- - `client_id`: Your Client Id for the Morgan Stanley API Platform. This is a GUID.
- - `scopes`: A list of scopes to request a token against, corresponding to the API you are calling. For help with finding the correct scope, please talk to your Morgan Stanley contact.
- - `thumbprint`: The thumbprint (also known as fingerprint) of your certificate, without colon separators. For example `AB48C0D31F95EBF8425AECF3E7E6FA92B34C8D47`
- - `private_key_file`: The path to your private key. This can be either an absolute or relative path. For example: `certs/private_key.pem`
- - `tenant`: The tenant you are requesting an access token against. 
-   - UAT: `api-uat.morganstanley.com`
-   - PROD : `api.morganstanley.com`
- - `proxy_host`: If you are running this app inside a restricted network environment, you should specify the hostname of the proxy you are using. e.g. `internal-proxy.company.com`
- - `proxy_port`: Set this to the port number for your proxy, if applicable. Should be an integer.
- - `url`: The URL to call. **NOTE** in a production app you probably won't source the URL like this, but this is just an example.
- - `requests_ca_bundle`: The file to use as the CA bundle when verifying HTTPS certificates. If omitted, use the default bundle shipped with the `requests` library. Please see the [SSL validation section](#ssl-validation-issues-and-the-requests-ca-bundle) for more details.
- - `disable_ssl_verification`: Explicitly disable SSL verification. **Not recommended for security reasons.**
+| Key                  | Description                                                                             |
+|----------------------|-----------------------------------------------------------------------------------------|
+| `client_id`          | The client id that will be sent to you from your Morgan Stanley contact                 |
+| `scopes`             | The scope/s that will be sent to you from your Morgan Stanley contact                   |
+| `thumbprint`         | The certificate thumbprint                                                              |
+| `private_key_file`   | The path to the private_key.pem that has been created                                   |
+| `tenant`             | The tenant that will be sent to you from your Morgan Stanley contact                    |
+| `url`                | The URL of the Morgan Stanley API endpoint you are connecting to                        |
+
+### Optional `config.json` Properties
+
+| Key                     | Description                                                                                          | Example Value                        |
+|-------------------------|------------------------------------------------------------------------------------------------------|--------------------------------------|
+| `proxy_host`            | Hostname of your proxy server (if inside a restricted network)                                       | `"internal-proxy.company.com"`       |
+| `proxy_port`            | Port number for your proxy (integer)                                                                 | `8080`                               |
+| `requests_ca_bundle`    | Path to CA bundle file for HTTPS certificate verification. If omitted, uses default from `requests`. | `"/path/to/ca-bundle.pem"`           |
+| `disable_ssl_verification` | Set to `true` to disable SSL verification (**not recommended for security reasons**).             | `false` or `true`                    |
+
+See [SSL validation section](#ssl-validation-issues-and-the-requests-ca-bundle) for more details.
 
 You can use `config-example.json` as a starting point.
 
@@ -52,7 +59,7 @@ python -m pip install --upgrade pip
 pip install -r requirements.txt
 pip install -r dev-requirements.txt
 
-python client-application.py
+python client_application.py
 ```
 
 Mac/Linux:   
@@ -64,7 +71,7 @@ pip install --upgrade pip
 pip install -r requirements.txt
 pip install -r dev-requirements.txt
 
-python client-application.py
+python client_application.py
 ```
 
 The application will launch and connect to the Morgan Stanley API offering and output the result.

client-samples/python/rest/config-example.json

@@ -5,8 +5,8 @@
   ],
   "thumbprint": "CERT THUMBPRINT",
   "private_key_file": "PATH TO PRIVATE KEY IN PEM FORMAT",
-  "tenant": "api.morganstanley.com",
+  "tenant": "TENANT",
   "proxy_host": "PROXY HOST HERE",
   "proxy_port": "PROXY PORT",
-  "url": "https://api.morganstanley.com/rest-example"
+  "url": "https://example-api.com"
 }