Skip to content

TA-4307: Make packageKey option required in the getTargets command. #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jetakasabaqi merged 2 commits into from
Oct 7, 2025
Merged

TA-4307: Make packageKey option required in the getTargets command. #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35c15b4
TA-4307: Make packageKey option required in the getTargets command.
jetakasabaqi Oct 6, 2025
9a780dc
TA-4307: Make packageKey option required in the getTargets command.
jetakasabaqi Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/commands/deployment/deployment-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,10 @@ export class DeploymentApi {
});
}

public async getTargets(deployableType: string, packageKey?: string): Promise<TargetTransport[]> {
public async getTargets(deployableType: string, packageKey: string): Promise<TargetTransport[]> {
const queryParams = new URLSearchParams();
queryParams.set("deployableType", deployableType);

if (packageKey) {
queryParams.set("packageKey", packageKey);
}
queryParams.set("packageKey", packageKey);

return this.httpClient()
.get(`/pacman/api/deployments/targets?${queryParams.toString()}`)
Expand Down
2 changes: 1 addition & 1 deletion src/commands/deployment/deployment.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export class DeploymentService {
}
}

public async getTargets(jsonResponse: boolean, deployableType: string, packageKey?: string): Promise<void> {
public async getTargets(jsonResponse: boolean, deployableType: string, packageKey: string): Promise<void> {
const targets = await this.deploymentApi.getTargets(deployableType, packageKey);

if (jsonResponse) {
Expand Down
2 changes: 1 addition & 1 deletion src/commands/deployment/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class Module extends IModule {
.beta()
.description("List all targets for a given deployable type and package key")
.requiredOption("--deployableType <deployableType>", "The type of the deployable")
.option("--packageKey <packageKey>", "Identifier of the package to list targets for")
.requiredOption("--packageKey <packageKey>", "Identifier of the package to list targets for")
.option("--json", "Return the response as a JSON file")
.action(this.listTargets);
}
Expand Down
17 changes: 4 additions & 13 deletions tests/commands/deployment/deployment-list-targets.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,19 @@ describe("Deployment list targets", () => {
}

it("Should list targets", async () => {
mockAxiosGet("https://myTeam.celonis.cloud/pacman/api/deployments/targets?deployableType=app-package", [firstTarget, secondTarget]);
mockAxiosGet("https://myTeam.celonis.cloud/pacman/api/deployments/targets?deployableType=app-package&packageKey=package-key", [firstTarget, secondTarget]);

await new DeploymentService(testContext).getTargets(false, "app-package");
await new DeploymentService(testContext).getTargets(false, "app-package", "package-key");

expect(loggingTestTransport.logMessages.length).toBe(2);
expect(loggingTestTransport.logMessages[0].message).toContain(`ID: ${firstTarget.id}, Name: ${firstTarget.name}`);
expect(loggingTestTransport.logMessages[1].message).toContain(`ID: ${secondTarget.id}, Name: ${secondTarget.name}`);
});

it("Should list targets with package key filter", async () => {
mockAxiosGet("https://myTeam.celonis.cloud/pacman/api/deployments/targets?deployableType=app-package&packageKey=package-key", [firstTarget]);

await new DeploymentService(testContext).getTargets(false, "app-package", "package-key");

expect(loggingTestTransport.logMessages.length).toBe(1);
expect(loggingTestTransport.logMessages[0].message).toContain(`ID: ${firstTarget.id}, Name: ${firstTarget.name}`);
});

it("Should list targets as JSON", async () => {
mockAxiosGet("https://myTeam.celonis.cloud/pacman/api/deployments/targets?deployableType=app-package", [firstTarget, secondTarget]);
mockAxiosGet("https://myTeam.celonis.cloud/pacman/api/deployments/targets?deployableType=app-package&packageKey=package-key", [firstTarget, secondTarget]);

await new DeploymentService(testContext).getTargets(true, "app-package");
await new DeploymentService(testContext).getTargets(true, "app-package","package-key");

const expectedFileName = loggingTestTransport.logMessages[0].message.split(FileService.fileDownloadedMessage)[1];

Expand Down