mirror of
https://github.com/apache/superset.git
synced 2026-04-14 13:44:46 +00:00
120 lines
3.8 KiB
TypeScript
120 lines
3.8 KiB
TypeScript
/**
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
|
|
import type { Response, APIResponse } from '@playwright/test';
|
|
import { expect } from '@playwright/test';
|
|
import * as unzipper from 'unzipper';
|
|
|
|
/**
|
|
* Common interface for response types with status() method.
|
|
* Supports both Response (network interception) and APIResponse (page.request API).
|
|
*/
|
|
type ResponseLike = Response | APIResponse;
|
|
|
|
/**
|
|
* Verify response has exact status code
|
|
* @param response - Playwright Response or APIResponse object
|
|
* @param expected - Expected status code
|
|
* @returns The response for chaining
|
|
*/
|
|
export function expectStatus<T extends ResponseLike>(
|
|
response: T,
|
|
expected: number,
|
|
): T {
|
|
expect(
|
|
response.status(),
|
|
`Expected status ${expected}, got ${response.status()}`,
|
|
).toBe(expected);
|
|
return response;
|
|
}
|
|
|
|
/**
|
|
* Verify response status code is one of the expected values
|
|
* @param response - Playwright Response or APIResponse object
|
|
* @param expected - Array of acceptable status codes
|
|
* @returns The response for chaining
|
|
*/
|
|
export function expectStatusOneOf<T extends ResponseLike>(
|
|
response: T,
|
|
expected: number[],
|
|
): T {
|
|
expect(
|
|
expected,
|
|
`Expected status to be one of ${expected.join(', ')}, got ${response.status()}`,
|
|
).toContain(response.status());
|
|
return response;
|
|
}
|
|
|
|
interface ExportZipOptions {
|
|
/** Directory name containing resource yaml files (e.g. 'charts', 'datasets') */
|
|
resourceDir: string;
|
|
/** Minimum number of resource yaml files expected (default: 1) */
|
|
minCount?: number;
|
|
/** Regex to validate Content-Disposition header (skipped if omitted) */
|
|
contentDispositionPattern?: RegExp;
|
|
/** Resource names that must each appear in at least one YAML filepath */
|
|
expectedNames?: string[];
|
|
}
|
|
|
|
/**
|
|
* Validate an export zip response: content-type, zip structure, and resource yaml files.
|
|
* Shared across chart and dataset export tests.
|
|
*/
|
|
export async function expectValidExportZip(
|
|
response: ResponseLike,
|
|
options: ExportZipOptions,
|
|
): Promise<void> {
|
|
const {
|
|
resourceDir,
|
|
minCount = 1,
|
|
contentDispositionPattern,
|
|
expectedNames,
|
|
} = options;
|
|
|
|
expect(response.headers()['content-type']).toContain('application/zip');
|
|
|
|
if (contentDispositionPattern) {
|
|
expect(response.headers()['content-disposition']).toMatch(
|
|
contentDispositionPattern,
|
|
);
|
|
}
|
|
|
|
const body = await response.body();
|
|
expect(body.length).toBeGreaterThan(0);
|
|
|
|
const entries: string[] = [];
|
|
const directory = await unzipper.Open.buffer(body);
|
|
directory.files.forEach(file => entries.push(file.path));
|
|
|
|
const resourceYamlFiles = entries.filter(
|
|
entry => entry.includes(`${resourceDir}/`) && entry.endsWith('.yaml'),
|
|
);
|
|
expect(resourceYamlFiles.length).toBeGreaterThanOrEqual(minCount);
|
|
expect(entries.some(entry => entry.endsWith('metadata.yaml'))).toBe(true);
|
|
|
|
if (expectedNames) {
|
|
for (const name of expectedNames) {
|
|
expect(
|
|
resourceYamlFiles.some(f => f.includes(name)),
|
|
`Expected export zip to contain a YAML file matching "${name}"`,
|
|
).toBe(true);
|
|
}
|
|
}
|
|
}
|