Merge pull request #2 from splunk/next

next version

Author: Siegfried Puchbauer

README.md

@@ -12,24 +12,30 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             # ...
-            - uses: splunk/appinspect-api-action@v1
+            - uses: splunk/appinspect-api-action@v2
               with:
                   filePath: ./dist/myapp.tar.gz
                   splunkUser: ${{ secrets.SPLUNKBASE_USER }}
                   splunkPassword: ${{ secrets.SPLUNKBASE_PASSWORD }}
                   includedTags: cloud
+                  failOnError: true
+                  failOnWarning: true
 ```
 
 ## Inputs
 
-| Name             | Description                                                                    |
-| ---------------- | ------------------------------------------------------------------------------ |
-| `filePath`       | Path to the app bundle file (.tar.gz or .spl)                                  |
-| `splunkUser`     | Splunk.com user used to login to the appinspect API                            |
-| `splunkPassword` | Splunk.com password used to login to the appinspect API                        |
-| `includedTags`   | Optional: Comma separated list of [tags](#tags) to include in appinspect job   |
-| `excludedTags`   | Optional: Comma separated list of [tags](#tags) to exclude from appinspect job |
-
-### Tags
-
-For more info on tags see [Splunk AppInspect tag reference](https://dev.splunk.com/enterprise/docs/reference/appinspecttagreference).
+| Name                   | Description                                                                                                | Notes            |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------- |
+| `filePath`             | Path to the app bundle file (.tar.gz or .spl)                                                              | **required**     |
+| `splunkUser`           | Splunk.com user used to login to the appinspect API                                                        | **required**     |
+| `splunkPassword`       | Splunk.com password used to login to the appinspect API                                                    | **required**     |
+| `includedTags`         | Comma separated list of [tags](#reference-docs) to include in appinspect job                               |                  |
+| `excludedTags`         | Comma separated list of [tags](#reference-docs) to exclude from appinspect job                             |                  |
+| `failOnError`          | If enabled the action will fail when errors or failures are reported by AppInspect                         | default: `true`  |
+| `failOnWarning`        | If enabled the action will fail when warnings are reported by AppInspect                                   | default: `false` |
+| `ignoredChecks`        | Comma separated list of [check names](#reference-docs) to explicitly ignore                                |                  |
+| `uploadReportArtifact` | If enabled the action will upload the HTML report from the AppInspect API as an artifact to GitHub actions | default: `true`  |
+
+### Reference Docs
+
+For more info on check critera, tags and the API see the [Splunk AppInspect reference](https://dev.splunk.com/enterprise/reference/appinspect).

action.yml

@@ -20,3 +20,18 @@ inputs:
     excludedTags:
         description: Comma separated list of tags to exclude from appinspect job
         required: false
+    failOnError:
+        description: If enabled the action will fail when errors or failures are reported by AppInspect (enabled by default)
+        required: false
+        default: 'true'
+    failOnWarning:
+        description: If enabled the action will fail when warnings are reported by AppInspect
+        required: false
+        default: 'false'
+    ignoredChecks:
+        description: Comma separated list of check names to explicitly ignore
+        required: false
+    uploadReportArtifact:
+        description: If enabled the action will upload the HTML report from the AppInspect API as an artifact to GitHub actions (enabled by default)
+        required: false
+        default: 'true'

dist/index.js

@@ -4,24 +4,23 @@
     "private": true,
     "main": "lib/main.js",
     "scripts": {
-        "build": "tsc",
-        "pack": "ncc build",
-        "all": "npm run build && npm run pack"
+        "build": "ncc build src/main.ts"
     },
     "license": "UNLICENSED",
     "dependencies": {
+        "@actions/artifact": "^0.5.1",
         "@actions/core": "^1.2.0",
         "@actions/exec": "^1.0.3",
-        "@actions/github": "^2.1.1",
-        "@vercel/ncc": "^0.28.3",
-        "form-data": "^3.0.0",
+        "@actions/github": "^4.0.0",
+        "@vercel/ncc": "^0.28.5",
+        "form-data": "^4.0.0",
         "node-fetch": "^2.6.0"
     },
     "devDependencies": {
         "@types/form-data": "^2.5.0",
-        "@types/node": "^12.7.12",
+        "@types/node": "^15.0.2",
         "@types/node-fetch": "^2.5.7",
-        "js-yaml": "^3.13.1",
-        "typescript": "^3.6.4"
+        "js-yaml": "^4.1.0",
+        "typescript": "^4.2.4"
     }
 }

lib/api.js

@@ -8,11 +8,13 @@ async function req<T>({
     method,
     body,
     headers,
+    json = true,
 }: {
     method: 'GET' | 'POST';
     url: string;
     headers?: { [k: string]: string };
     body?: any;
+    json?: boolean;
 }): Promise<T> {
     const res = await fetch(url, {
         method,
@@ -28,7 +30,7 @@ async function req<T>({
         }
         throw new Error(`HTTP status ${res.status} from ${url}`);
     }
-    return res.json();
+    return json ? res.json() : res.text();
 }
 
 export interface AuthResponse {
@@ -200,12 +202,31 @@ export interface ReportResponse {
     }>;
 }
 
-export async function getReport(data: { request_id: string; token: string }): Promise<ReportResponse> {
+export async function getReportInternal<T>({
+    request_id,
+    token,
+    format = 'json',
+}: {
+    request_id: string;
+    token: string;
+    format?: 'json' | 'html';
+}): Promise<T> {
+    const contentType = format === 'html' ? 'text/html' : 'application/json';
     return req({
         method: 'GET',
-        url: `https://appinspect.splunk.com/v1/app/report/${encodeURIComponent(data.request_id)}`,
+        url: `https://appinspect.splunk.com/v1/app/report/${encodeURIComponent(request_id)}`,
         headers: {
-            Authorization: `Bearer ${data.token}`,
+            Authorization: `Bearer ${token}`,
+            'Content-Type': contentType,
         },
+        json: format === 'json',
     });
 }
+
+export async function getReport({ request_id, token }: { request_id: string; token: string }): Promise<ReportResponse> {
+    return getReportInternal({ request_id, token, format: 'json' });
+}
+
+export async function getHtmlReport({ request_id, token }: { request_id: string; token: string }): Promise<string> {
+    return getReportInternal({ request_id, token, format: 'html' });
+}