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

feat(datasource/azure-pipelines-tasks): add azure-pipelines-tasks datasource #16904

Merged
merged 18 commits into from
Aug 9, 2022
Merged
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
2 changes: 2 additions & 0 deletions lib/modules/datasource/api.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { AdoptiumJavaDatasource } from './adoptium-java';
import { ArtifactoryDatasource } from './artifactory';
import { AwsMachineImageDataSource } from './aws-machine-image';
import { AzurePipelinesTasksDatasource } from './azure-pipelines-tasks';
import { BitBucketTagsDatasource } from './bitbucket-tags';
import { CdnJsDatasource } from './cdnjs';
import { ClojureDatasource } from './clojure';
Expand Down Expand Up @@ -51,6 +52,7 @@ export default api;
api.set(AdoptiumJavaDatasource.id, new AdoptiumJavaDatasource());
api.set(ArtifactoryDatasource.id, new ArtifactoryDatasource());
api.set(AwsMachineImageDataSource.id, new AwsMachineImageDataSource());
api.set(AzurePipelinesTasksDatasource.id, new AzurePipelinesTasksDatasource());
api.set(BitBucketTagsDatasource.id, new BitBucketTagsDatasource());
api.set(CdnJsDatasource.id, new CdnJsDatasource());
api.set(ClojureDatasource.id, new ClojureDatasource());
Expand Down
31 changes: 31 additions & 0 deletions lib/modules/datasource/azure-pipelines-tasks/index.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { getPkgReleases } from '..';
import { AzurePipelinesTasksDatasource } from '.';

describe('modules/datasource/azure-pipelines-tasks/index', () => {
it('returns null for unknown task', async () => {
expect(
await getPkgReleases({
datasource: AzurePipelinesTasksDatasource.id,
depName: 'unknown',
})
).toBeNull();
});

it('supports built-in tasks', async () => {
expect(
await getPkgReleases({
datasource: AzurePipelinesTasksDatasource.id,
depName: 'AutomatedAnalysis',
})
).toEqual({ releases: [{ version: '0.171.0' }, { version: '0.198.0' }] });
});

it('is case insensitive', async () => {
expect(
await getPkgReleases({
datasource: AzurePipelinesTasksDatasource.id,
depName: 'automatedanalysis',
})
).toEqual({ releases: [{ version: '0.171.0' }, { version: '0.198.0' }] });
});
});
33 changes: 33 additions & 0 deletions lib/modules/datasource/azure-pipelines-tasks/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import dataFiles from '../../../data-files.generated';
import { id as versioning } from '../../versioning/loose';
import { Datasource } from '../datasource';
import type { GetReleasesConfig, ReleaseResult } from '../types';

export class AzurePipelinesTasksDatasource extends Datasource {
static readonly id = 'azure-pipelines-tasks';

private readonly builtInTasks: Record<string, string[]>;

constructor() {
super(AzurePipelinesTasksDatasource.id);
this.builtInTasks = JSON.parse(
dataFiles.get('data/azure-pipelines-tasks.json')!
);
}

override readonly customRegistrySupport = false;

override readonly defaultVersioning = versioning;

getReleases({
packageName,
}: GetReleasesConfig): Promise<ReleaseResult | null> {
const versions = this.builtInTasks[packageName.toLowerCase()];
if (versions) {
const releases = versions.map((version) => ({ version }));
return Promise.resolve({ releases });
}

return Promise.resolve(null);
}
}
2 changes: 2 additions & 0 deletions lib/modules/datasource/azure-pipelines-tasks/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This datasource returns versions of the [built-in Azure Pipelines tasks](https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/?view=azure-devops).
It does not yet support Azure Pipelines tasks from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/search?target=AzureDevOps&category=Azure%20Pipelines)
26 changes: 23 additions & 3 deletions lib/modules/manager/azure-pipelines/extract.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Fixtures } from '../../../../test/fixtures';
import { AzurePipelinesTasksDatasource } from '../../datasource/azure-pipelines-tasks';
import {
extractAzurePipelinesTasks,
extractContainer,
Expand Down Expand Up @@ -96,6 +97,7 @@ describe('modules/manager/azure-pipelines/extract', () => {
expect(extractAzurePipelinesTasks('Bash@3')).toEqual({
depName: 'Bash',
currentValue: '3',
datasource: AzurePipelinesTasksDatasource.id,
});
});

Expand Down Expand Up @@ -142,23 +144,41 @@ describe('modules/manager/azure-pipelines/extract', () => {
azurePipelinesStages,
azurePipelinesFilename
);
expect(res?.deps).toEqual([{ depName: 'Bash', currentValue: '3' }]);
expect(res?.deps).toEqual([
{
depName: 'Bash',
currentValue: '3',
datasource: AzurePipelinesTasksDatasource.id,
},
]);
});

it('should extract jobs', () => {
const res = extractPackageFile(
azurePipelinesJobs,
azurePipelinesFilename
);
expect(res?.deps).toEqual([{ depName: 'Bash', currentValue: '3' }]);
expect(res?.deps).toEqual([
{
depName: 'Bash',
currentValue: '3',
datasource: AzurePipelinesTasksDatasource.id,
},
]);
});

it('should extract steps', () => {
const res = extractPackageFile(
azurePipelinesSteps,
azurePipelinesFilename
);
expect(res?.deps).toEqual([{ depName: 'Bash', currentValue: '3' }]);
expect(res?.deps).toEqual([
{
depName: 'Bash',
currentValue: '3',
datasource: AzurePipelinesTasksDatasource.id,
},
]);
});

it('should return null when task alias used', () => {
Expand Down
2 changes: 2 additions & 0 deletions lib/modules/manager/azure-pipelines/extract.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { load } from 'js-yaml';
import { logger } from '../../../logger';
import { regEx } from '../../../util/regex';
import { AzurePipelinesTasksDatasource } from '../../datasource/azure-pipelines-tasks';
import { GitTagsDatasource } from '../../datasource/git-tags';
import { getDep } from '../dockerfile/extract';
import type { PackageDependency, PackageFile } from '../types';
Expand Down Expand Up @@ -59,6 +60,7 @@ export function extractAzurePipelinesTasks(
return {
depName: match.groups.name,
currentValue: match.groups.version,
datasource: AzurePipelinesTasksDatasource.id,
};
}
return null;
Expand Down
6 changes: 5 additions & 1 deletion lib/modules/manager/azure-pipelines/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
import { AzurePipelinesTasksDatasource } from '../../datasource/azure-pipelines-tasks';
import { GitTagsDatasource } from '../../datasource/git-tags';
export { extractPackageFile } from './extract';

export const defaultConfig = {
fileMatch: ['azure.*pipelines?.*\\.ya?ml$'],
};

export const supportedDatasources = [GitTagsDatasource.id];
export const supportedDatasources = [
AzurePipelinesTasksDatasource.id,
GitTagsDatasource.id,
];