Skip to content
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.

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

fix: project name when using assets-project-name flag #5077

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions src/cli/commands/monitor/index.ts
Expand Up @@ -356,6 +356,7 @@ function generateMonitorMeta(options, packageManager?): MonitorMeta {
prune: !!options.pruneRepeatedSubdependencies,
'remote-repo-url': options['remote-repo-url'],
targetReference: options['target-reference'],
assetsProjectName: options['assets-project-name'],
};
}

Expand Down
4 changes: 4 additions & 0 deletions src/lib/monitor/utils.ts
Expand Up @@ -47,6 +47,10 @@ export function getProjectName(
return scannedProject.meta.gradleProjectName;
}

if (meta.assetsProjectName && !meta['project-name']) {
return scannedProject.depTree?.name;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question (non-blocking): Is it desired behaviour for this to return an undefined or do we want it always to return a string?


return meta['project-name'];
}

Expand Down
1 change: 1 addition & 0 deletions src/lib/types.ts
Expand Up @@ -156,6 +156,7 @@ export interface MonitorMeta {
prune: boolean;
'remote-repo-url'?: string;
targetReference?: string;
assetsProjectName?: boolean;
}

export interface Tag {
Expand Down
58 changes: 58 additions & 0 deletions test/jest/unit/cli-monitor-utils.spec.ts
Expand Up @@ -114,6 +114,64 @@ describe('cli-monitor-utils test', () => {
expect(res).toEqual('project-name-override');
});

it('getProjectName returns nuget project name from scanned project meta when --assets-project-name is provided via options', () => {
const scannedProject: ScannedProject = {
depTree: {
dependencies: {
'Microsoft.Extensions.FileProviders.Embedded': {
name: 'Microsoft.Extensions.FileProviders.Embedded',
version: '6.0.22',
},
},
name: 'nuget-project-assets-name',
packageFormatVersion: 'nuget:0.0.0',
version: '0.0.1',
targetFile: 'project.assets.json',
},
targetFile: 'project.assets.json',
};

const res = utils.getProjectName(scannedProject, {
method: 'cli',
packageManager: 'nuget',
'policy-path': '',
'project-name': '',
isDocker: false,
prune: false,
assetsProjectName: true,
});
expect(res).toEqual('nuget-project-assets-name');
});

it('getProjectName overrides --assets-project-name with value from --project-name flag', () => {
const scannedProject: ScannedProject = {
depTree: {
dependencies: {
'Microsoft.Extensions.FileProviders.Embedded': {
name: 'Microsoft.Extensions.FileProviders.Embedded',
version: '6.0.22',
},
},
name: 'nuget-project-assets-name',
packageFormatVersion: 'nuget:0.0.0',
version: '0.0.1',
targetFile: 'project.assets.json',
},
targetFile: 'project.assets.json',
};

const res = utils.getProjectName(scannedProject, {
method: 'cli',
packageManager: 'nuget',
'policy-path': '',
'project-name': 'project-name-from-option',
isDocker: false,
prune: false,
assetsProjectName: true,
});
expect(res).toEqual('project-name-from-option');
});

it('getProjectName returns gradle project name from scanned project meta', () => {
const scannedProject: ScannedProject = {
depGraph: {} as any,
Expand Down