Initial commit

Author: bdd4329

.github/workflows/update-semver.yaml

@@ -0,0 +1,13 @@
+name: Update Semver
+on:
+  push:
+    branches-ignore:
+      - '**'
+    tags:
+      - 'v*.*.*'
+jobs:
+  update-semver:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: haya14busa/action-update-semver@v1

.gitignore

@@ -0,0 +1 @@
+venv

README.md

@@ -0,0 +1,70 @@
+# it-ae-actions-servicenow
+
+This composite action is used to modify a Service Now request
+
+## Example usages
+
+- Add a comment
+```yaml
+steps:
+  - name: Update Service Now Request
+    uses: tamu-edu/[email protected]
+    with:
+      sn-base-url: ${{ vars.SN_BASE_URL }}
+      sn-username: ${{ secrets.SN_USERNAME }}
+      sn-password: ${{ secrets.SN_PASSWORD }}
+      action-version: v1.0
+      sn-request-id: 99e15216db4fb114c02e6909139619d2
+      sn-action: add_comment
+      sn-input1: My comment
+      github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+- Add a work note
+```yaml
+steps:
+  - name: Update Service Now Request
+    uses: tamu-edu/[email protected]
+    with:
+      sn-base-url: ${{ vars.SN_BASE_URL }}
+      sn-username: ${{ secrets.SN_USERNAME }}
+      sn-password: ${{ secrets.SN_PASSWORD }}
+      action-version: v1.0
+      sn-request-id: 99e15216db4fb114c02e6909139619d2
+      sn-action: add_work_notes
+      sn-input1: My work note
+      github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+- Close a Request
+```yaml
+steps:
+  - name: Update Service Now Request
+    uses: tamu-edu/[email protected]
+    with:
+      sn-base-url: ${{ vars.SN_BASE_URL }}
+      sn-username: ${{ secrets.SN_USERNAME }}
+      sn-password: ${{ secrets.SN_PASSWORD }}
+      action-version: v1.0
+      sn-request-id: 99e15216db4fb114c02e6909139619d2
+      sn-action: close_request
+      sn-input1: ""
+      github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+- Update a Request variable called 'resource_url':
+```yaml
+steps:
+  - name: Update Service Now Request
+    uses: tamu-edu/[email protected]
+    with:
+      sn-base-url: ${{ vars.SN_BASE_URL }}
+      sn-username: ${{ secrets.SN_USERNAME }}
+      sn-password: ${{ secrets.SN_PASSWORD }}
+      action-version: v1.0
+      sn-request-id: 99e15216db4fb114c02e6909139619d2
+      sn-action: update_request_variable
+      sn-input1: resource_url
+      sn-input2: Testing composite action 2
+      github-token: ${{ secrets.GITHUB_TOKEN }}
+```

action.yaml

@@ -0,0 +1,111 @@
+name: TDx Request Management
+description: Modifies TDx Requests
+inputs:
+  action-version:
+    type: string
+    title: Action Version
+    description: The version of the action to use
+    required: true
+  github-token:
+    type: string
+    title: GitHub Token
+    description: The GitHub token to use for authentication
+    required: true
+  tdx-base-url:
+    type: string
+    title: TDx Base URL
+    description: The base URL of the TDx instance
+    required: true
+  tdx-account_id:
+    type: string
+    title: TDx Account ID
+    description: The username to use for authentication
+    required: true
+  tdx-secret:
+    type: string
+    title: TDx Secret
+    description: The password to use for authentication
+    required: true
+  tdx-request-id:
+    type: string
+    title: TDx Request ID
+    description: The ID of the TDx request to modify
+    required: true
+  tdx-action:
+    type: string
+    title: TDx Action
+    description: The action to perform on the TDx request
+    required: true
+    enum:
+      - add_comment_and_notify
+      - close_request
+      - update_request_variable_and_close_request
+
+  # Usage:
+  # The inputs to use for the TDx action. The inputs are
+  # different for each action. Use the following as a guide -
+  # * add_comment_and_notify - `my comment`
+  # * close_request - ``
+  # * update_request_variable_and_close_request - `my_variable` and `my value`
+
+  tdx-input1:
+    type: string
+    title: TDx Input 1
+    description: The first input to the TDx action
+    required: true
+  tdx-input2:
+    type: string
+    title: TDx Input 2
+    description: The second input to the TDx action (optional)
+    required: false
+
+outputs:
+  output:
+    description: Output from the TDx action script
+    value: ${{ steps.run-tdx-action.outputs.output }}
+
+runs:
+  using: composite
+  steps:
+    - name: Checkout actions repo
+      uses: actions/checkout@v4
+      with:
+        repository: tamu-edu/it-ae-actions-tdx
+        path: action
+        ref: ${{ inputs.action-version }}
+        token: ${{ inputs.github-token }}
+
+    - name: Install python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12'
+    - name: Install python dependencies
+      shell: bash
+      run: pip install -r ./action/python/requirements.txt
+
+    - name: run-tdx-action
+      shell: bash
+      env:
+        TDX_BASE_URL: ${{ inputs.tdx-base-url }}
+        TDX_ACCOUNT_ID: ${{ inputs.tdx-account_id }}
+        TDX_SECRET: ${{ inputs.tdx-secret }}
+      run: |
+        ARGS="--request_id ${{ inputs.tdx-request-id }}"
+        if [[ "${{ inputs.tdx-action }}" == "add_comment_and_notify" ]]; then
+          ARGS="${ARGS} add_comment_and_notify --comment \"${{ inputs.tdx-input1 }}\""
+        elif [[ "${{ inputs.tdx-action }}" == "update_request_variable_and_close_request" ]]; then
+          ARGS="${ARGS} update_request_variable_and_close_request --variable_name ${{ inputs.tdx-input1 }} --variable_value \"${{ inputs.tdx-input2 }}\""
+        elif [[ "${{ inputs.tdx-action }}" == "close_request" ]]; then
+          ARGS="${ARGS} close_request --close"
+        else
+          echo "Invalid action: '${{ inputs.tdx-action }}'"
+          exit 1
+        fi
+
+        echo "ARGS: ${ARGS}"
+
+        eval python ./action/python/tdx_updater.py ${ARGS} 2>&1 | tee /tmp/output.txt
+        echo "output<<EOF" >> $GITHUB_OUTPUT
+        cat /tmp/output.txt >> $GITHUB_OUTPUT
+        echo "EOF" >> $GITHUB_OUTPUT
+

python/requirements.txt

@@ -0,0 +1 @@
+requests

python/tdx_updater.py

@@ -0,0 +1,116 @@
+import argparse
+import os
+from pprint import pprint
+import requests
+
+import logging
+import http.client
+
+logging.basicConfig(level=logging.DEBUG)
+
+httpclient_logger = logging.getLogger("http.client")
+
+def httpclient_logging_patch(level=logging.DEBUG):
+    """Enable HTTPConnection debug logging to the logging framework"""
+
+    def httpclient_log(*args):
+        httpclient_logger.log(level, " ".join(args))
+
+    # mask the print() built-in in the http.client module to use
+    # logging instead
+    http.client.print = httpclient_log
+    # enable debugging
+    http.client.HTTPConnection.debuglevel = 1
+
+httpclient_logging_patch()
+
+
+class TDxUpdater:
+    def __init__(self, base_url: str, account_id: str, secret: str, flow_id: str) -> None:
+        self._base_url = base_url
+        self._account_id = account_id
+        self._secret = secret
+        self._flow_id = flow_id
+
+    def _get_auth_header(self) -> dict:
+        return {
+            "X-TdxiPaaS-AccountId": self._account_id,
+            "X-TdxiPaaS-Secret": self._secret,
+        }
+    
+    def _get_flow_url(self) -> str:
+        return f"{self._base_url}/start/{self._flow_id}"
+
+    def add_request_comment(self, request_id: str, comment: str) -> None:
+        pass
+
+    def close_request(
+        self, request_id: str, variable_name: str = None, variable_value: str = None
+    ) -> None:
+        data = {"ticket_number": int(request_id)}
+        if variable_name and variable_value:
+            data[variable_name] = variable_value
+        r = requests.post(headers=self._get_auth_header(), json=data, url=self._get_flow_url())
+
+        if r.status_code != 200:
+            raise ValueError(f"Failed to close request: {r.status_code}: {r.reason} ({r.text})")
+        else:
+            print(f"Request {request_id} closed successfully")
+
+
+def main():
+
+    assert "TDX_BASE_URL" in os.environ, "TDX_BASE_URL not set (format: https://us1.teamdynamix.com/tdapp/app/flow/api/v1)"
+    assert "TDX_ACCOUNT_ID" in os.environ, "TDX_ACCOUNT_ID not set (format: c4a4f617-0510-4dcb-af07-5ae296c858d0)"
+    assert "TDX_SECRET" in os.environ, "TDX_SECRET not set"
+
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--request_id", help="ServiceNow request ID", required=True)
+    parser.add_argument("--flow_id", help="Flow ID", required=True)
+    subparsers = parser.add_subparsers(help="Action to perform")
+    group_comment_and_notify = subparsers.add_parser(
+        "add_comment_and_notify", help="Add comment to request and notify user"
+    )
+    group_comment_and_notify.add_argument(
+        "--comment", help="Comment to add to request", required=False
+    )
+    group_update_variable_and_close = subparsers.add_parser(
+        "update_request_variable_and_close_request",
+        help="Update request variable and close request",
+    )
+    group_update_variable_and_close.add_argument(
+        "--variable_name", help="Variable name to update", required=True
+    )
+    group_update_variable_and_close.add_argument(
+        "--variable_value", help="Variable value to update", required=True
+    )
+
+    group_close_request = subparsers.add_parser("close_request", help="Close request")
+    group_close_request.add_argument(
+        "--close", help="Close request", action="store_true"
+    )
+
+    args = parser.parse_args()
+
+    tdx_updater = TDxUpdater(
+        base_url=os.environ["TDX_BASE_URL"],
+        account_id=os.environ["TDX_ACCOUNT_ID"],
+        secret=os.environ["TDX_SECRET"],
+        flow_id=args.flow_id
+    )
+
+    if "add_comment_and_notify" in args:
+        tdx_updater.add_request_comment(args.request_id, args.comment)
+    elif "variable_name" in args and "variable_value" in args:
+        tdx_updater.close_request(
+            args.request_id, args.variable_name, args.variable_value
+        )
+    elif "close" in args:
+        tdx_updater.close_request(args.request_id)
+    else:
+        raise ValueError("No action specified")
+
+
+if __name__ == "__main__":
+    main()