apache / apache/rocketmq-dashboard

Add regression coverage for Tencent cloud catalog API requests

Open Beginner friendly
#4,040 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
1.4k
Forks
683
Avg merge
2d 14h
Merged PRs (30d)
58

Description

## Problem
The current test suite does not cover Tencent cloud catalog API requests.

## Expected behavior
- A focused Vitest case locks the existing behavior.
- The targeted test file passes and fails if the covered behavior regresses.

## Scope
Only add regression coverage for $(@{Slug=tencent-catalog; Focus=Tencent cloud catalog API requests; PrTitle=test(tencent-catalog): cover cloud catalog API requests; TestFile=web/src/api/__tests__/tencentCatalog.test.ts; Mode=new; Append=/*
* 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 MockAdapter from 'axios-mock-adapter';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import client from '../client';
import { listTencentInstances, listTencentRegions } from '../tencentCatalog';

const mock = new MockAdapter(client);

describe('tencentCatalog API', () => {
beforeEach(() => {
mock.reset();
});

afterEach(() => {
mock.reset();
});

it('lists Tencent regions for a credential', async () => {
const regions = [{ regionId: 'ap-guangzhou', regionName: '广州' }];
mock.onGet('/cloud/tencent/regions').reply((config) => {
expect(config.params).toEqual({ credentialId: 7 });
return [200, { data: regions }];
});

await expect(listTencentRegions(7)).resolves.toEqual(regions);
});

it('forwards optional search when listing Tencent instances', async () => {
const instances = [{ instanceId: 'rocketmq-prod', instanceName: 'prod' }];
mock.onGet('/cloud/tencent/instances').reply((config) => {
expect(config.params).toEqual({
credentialId: 7,
regionId: 'ap-guangzhou',
search: 'prod',
});
return [200, { data: instances }];
});

await expect(
listTencentInstances(7, 'ap-guangzhou', 'prod'),
).resolves.toEqual(instances);
});
});}.TestFile). No runtime behavior changes.

## Acceptance criteria
- [ ] The targeted Vitest file passes.
- [ ] git diff --check is clean.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with web/src/api/__tests__/tencentCatalog.test.ts and the imported web/src/api/tencentCatalog module, then run the targeted Vitest file to compare its existing API behavior with the requested coverage. Add focused checks for listing regions and instances, including request parameters and returned data; done means the targeted test passes and git diff --check is clean.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, cloud, testing
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.