chore: merge develop into main (#1464)

splunk · Nov 18, 2024 · b59b299 · b59b299
2 parents d6ec743 + feb9bdf
commit b59b299
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 20 deletions.
diff --git a/.github/workflows/build-test-release.yml b/.github/workflows/build-test-release.yml
@@ -227,7 +227,7 @@ jobs:
           path: Splunk_TA_UCCExample*.tar.gz
 
   test-ui:
-    name: test-ui Splunk ${{ matrix.splunk.version }} -m ${{ matrix.test-mark }}
+    name: test-ui Splunk ${{ matrix.splunk.version }} -group ${{ matrix.test-group }}
     runs-on: ubuntu-22.04
     permissions:
       id-token: write
@@ -243,14 +243,17 @@ jobs:
       fail-fast: false
       matrix:
         splunk: ${{ fromJson(needs.meta.outputs.matrix_supportedSplunk) }}
-        test-mark:
-          - "logging"
-          - "proxy"
-          - "account"
-          - "custom"
-          - "alert"
-          - "input"
-          - "configuration"
+        test-group:
+          - "1"
+          - "2"
+          - "3"
+          - "4"
+          - "5"
+          - "6"
+          - "7"
+          - "8"
+          - "9"
+          - "10"
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -272,16 +275,16 @@ jobs:
           ./scripts/run_splunk.sh ${{ matrix.splunk.version }}
           until curl -Lsk "https://localhost:8088/services/collector/health" &>/dev/null ; do echo -n "Waiting for HEC-" && sleep 5 ; done
         timeout-minutes: 5
-      - run: poetry run pytest tests/ui -m "${{ matrix.test-mark }}" --headless --junitxml=test-results/junit.xml
+      - run: poetry run pytest tests/ui --test-group-count 10 --test-group ${{ matrix.test-group }} --test-group-random-seed 123456 --headless --junitxml=test-results/junit.xml
       - uses: actions/upload-artifact@v4
         if: success() || failure()
         with:
-          name: test-results-ui-${{ matrix.splunk.version }}-${{ matrix.test-mark }}
+          name: test-results-ui-${{ matrix.splunk.version }}-${{ matrix.test-group }}
           path: test-results/*
       - uses: dorny/test-reporter@v1
         if: success() || failure()
         with:
-          name: test-report-ui-${{ matrix.splunk.version }}-${{ matrix.test-mark }}
+          name: test-report-ui-${{ matrix.splunk.version }}-${{ matrix.test-group }}
           path: "test-results/*.xml"
           reporter: java-junit
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -68,6 +68,7 @@ mkdocs-print-site-plugin = "^2.3.6"
 pytest-cov = "^4.0.0"
 covdefaults = "^2.3.0"
 xmldiff = "^2.6.3"
+pytest-split-tests = "^1.1.0"
 
 [tool.poetry.scripts]
 ucc-gen="splunk_add_on_ucc_framework.main:main"

diff --git a/ui/src/components/SingleInputComponent/SingleInputComponent.test.tsx b/ui/src/components/SingleInputComponent/SingleInputComponent.test.tsx
@@ -49,8 +49,8 @@ const renderFeature = (additionalProps?: Partial<SingleInputComponentProps>) =>
 const mockedEntries = [
     { name: 'dataApiTest1', content: { testLabel: 'firstLabel', testValue: 'firstValue' } },
     { name: 'dataApiTest2', content: { testLabel: 'secondLabel', testValue: 'secondValue' } },
-    { name: 'dataApiTest3', content: { testLabel: 'thirdLabel', testValue: 'thirdValue' } },
-    { name: 'dataApiTest4', content: { testLabel: 'fourthLabel', testValue: 'fourthValue' } },
+    { name: 'true', content: { testLabel: 'thirdLabel', testValue: 'thirdValue' } },
+    { name: '0', content: { testLabel: 'fourthLabel', testValue: 'fourthValue' } },
 ];
 
 const MOCK_API_URL = '/demo_addon_for_splunk/some_API_endpint_for_select_data';
@@ -167,3 +167,67 @@ it.each([
     const { label } = autoCompleteFields[0];
     expect(within(inputComponent).getByText(label)).toBeInTheDocument();
 });
+
+it('should fetch options from API when endpointUrl is provided', async () => {
+    // server responses with a filtered mockedEntries based on the name parameter
+    server.use(
+        http.get(MOCK_API_URL, ({ request }) => {
+            const url = new URL(request.url);
+
+            const nameParameter = url.searchParams.get('name');
+            return HttpResponse.json(
+                getMockServerResponseForInput(
+                    mockedEntries.filter((entry) => entry.name === nameParameter)
+                )
+            );
+        })
+    );
+    const baseProps = {
+        ...defaultInputProps,
+        value: '',
+        controlOptions: {
+            createSearchChoice: true,
+            dependencies: ['name', 'region'],
+            endpointUrl: MOCK_API_URL,
+            labelField: 'testLabel',
+            valueField: 'testValue',
+        },
+    };
+    const { rerender } = render(<SingleInputComponent {...baseProps} />);
+
+    await userEvent.click(screen.getByRole('combobox'));
+    await screen.findByRole('menuitem', { name: 'No matches' });
+
+    // undefined value must be omitted
+    const firstEntry = mockedEntries[0];
+    rerender(
+        <SingleInputComponent
+            {...baseProps}
+            dependencyValues={{ name: firstEntry.name, region: undefined }}
+        />
+    );
+    await userEvent.click(screen.getByRole('combobox'));
+    await screen.findByRole('option', { name: firstEntry.content.testLabel });
+
+    const secondEntry = mockedEntries[1];
+    rerender(
+        <SingleInputComponent
+            {...baseProps}
+            dependencyValues={{ name: secondEntry.name, region: 1 }}
+        />
+    );
+    await userEvent.click(screen.getByRole('combobox'));
+    await screen.findByRole('option', { name: secondEntry.content.testLabel });
+
+    const thirdEntry = mockedEntries[2];
+    rerender(
+        <SingleInputComponent {...baseProps} dependencyValues={{ name: true, region: false }} />
+    );
+    await userEvent.click(screen.getByRole('combobox'));
+    await screen.findByRole('option', { name: thirdEntry.content.testLabel });
+
+    const fourthEntry = mockedEntries[3];
+    rerender(<SingleInputComponent {...baseProps} dependencyValues={{ name: 0, region: 0 }} />);
+    await userEvent.click(screen.getByRole('combobox'));
+    await screen.findByRole('option', { name: fourthEntry.content.testLabel });
+});
diff --git a/ui/src/util/api.ts b/ui/src/util/api.ts
@@ -5,9 +5,11 @@ import { generateToast, getUnifiedConfigs } from './util';
 import { parseErrorMsg } from './messageUtil';
 import { ResponseError } from './ResponseError';
 
+type ParamsRecord = Record<string, string | number | undefined>;
+
 export interface RequestParams {
     endpointUrl: string;
-    params?: Record<string, string | number>;
+    params?: ParamsRecord;
     signal?: AbortSignal;
     body?: BodyInit;
     handleError: boolean;
@@ -21,14 +23,14 @@ export function generateEndPointUrl(name: string) {
 
 const DEFAULT_PARAMS = { output_mode: 'json' };
 
-function createUrl(endpointUrl: string, params: Record<string, string | number>): URL {
+function createUrl(endpointUrl: string, params: ParamsRecord): URL {
     const url = new URL(
         createRESTURL(endpointUrl, { app, owner: 'nobody' }),
         window.location.origin
     );
-    Object.entries({ ...DEFAULT_PARAMS, ...params }).forEach(([key, value]) =>
-        url.searchParams.append(key, value.toString())
-    );
+    Object.entries({ ...DEFAULT_PARAMS, ...params })
+        .filter(([, value]) => value !== undefined && value !== null)
+        .forEach(([key, value]) => url.searchParams.append(key, value.toString()));
     return url;
 }