renovatebot · rarkins · Oct 1, 2021 · Sep 1, 2021 · Sep 3, 2021 · Sep 6, 2021
diff --git a/lib/datasource/api.ts b/lib/datasource/api.ts
@@ -1,4 +1,5 @@
 import { AdoptiumJavaDatasource } from './adoptium-java';
+import { ArtifactoryDatasource } from './artifactory';
 import { BitBucketTagsDatasource } from './bitbucket-tags';
 import { CdnJsDatasource } from './cdnjs';
 import { ClojureDatasource } from './clojure';
@@ -38,6 +39,7 @@ const api = new Map<string, DatasourceApi>();
 export default api;
 
 api.set(AdoptiumJavaDatasource.id, new AdoptiumJavaDatasource());
+api.set(ArtifactoryDatasource.id, new ArtifactoryDatasource());
 api.set('bitbucket-tags', new BitBucketTagsDatasource());
 api.set('cdnjs', new CdnJsDatasource());
 api.set('clojure', new ClojureDatasource());

diff --git a/lib/datasource/artifactory/__fixtures__/releases-as-files.html b/lib/datasource/artifactory/__fixtures__/releases-as-files.html
@@ -0,0 +1,21 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+  <head>
+    <meta name="robots" content="noindex" />
+    <title>Repository Title</title>
+  </head>
+
+  <body>
+    <h1>Index</h1>
+       <pre>Name      Last modified      Size</pre><hr/>
+       <pre>
+         <a href="..">..</a>
+         <a href="1.0.0">1.0.0</a>  21-Jul-2021 20:08    -
+         <a href="1.0.1">1.0.1</a>  23-Aug-2021 20:03    -
+         <a href="1.0.2">1.0.2</a>  21-Jul-2021 20:09    -
+         <a href="1.0.3">1.0.3</a>  06-Feb-2021 09:54    -
+       </pre>
+       <hr/>
+       <address style="font-size:small;">Artifactory Port 8080</address>
+  </body>
+</html>
diff --git a/lib/datasource/artifactory/__fixtures__/releases-as-folders.html b/lib/datasource/artifactory/__fixtures__/releases-as-folders.html
@@ -0,0 +1,21 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+  <head>
+    <meta name="robots" content="noindex" />
+    <title>Repository Title</title>
+  </head>
+
+  <body>
+    <h1>Index</h1>
+       <pre>Name      Last modified      Size</pre><hr/>
+       <pre>
+         <a href="../">../</a>
+         <a href="1.0.0/">1.0.0/</a>  21-Jul-2021 20:08    -
+         <a href="1.0.1/">1.0.1/</a>  23-Aug-2021 20:03    -
+         <a href="1.0.2/">1.0.2/</a>  21-Jul-2021 20:09    -
+         <a href="1.0.3/">1.0.3/</a>  06-Feb-2021 09:54    -
+       </pre>
+       <hr/>
+       <address style="font-size:small;">Artifactory Port 8080</address>
+  </body>
+</html>
diff --git a/lib/datasource/artifactory/__snapshots__/index.spec.ts.snap b/lib/datasource/artifactory/__snapshots__/index.spec.ts.snap
@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`datasource/artifactory/index getReleases parses real data (files): without slash at the end 1`] = `
+Object {
+  "homepage": "https://jfrog.com/artifactory",
+  "registryUrl": "https://jfrog.company.com/artifactory",
+  "releases": Array [
+    Object {
+      "version": "1.0.0",
+    },
+    Object {
+      "version": "1.0.1",
+    },
+    Object {
+      "version": "1.0.2",
+    },
+    Object {
+      "version": "1.0.3",
+    },
+  ],
+}
+`;
+
+exports[`datasource/artifactory/index getReleases parses real data (folders): with slash at the end 1`] = `
+Object {
+  "homepage": "https://jfrog.com/artifactory",
+  "registryUrl": "https://jfrog.company.com/artifactory",
+  "releases": Array [
+    Object {
+      "version": "1.0.0",
+    },
+    Object {
+      "version": "1.0.1",
+    },
+    Object {
+      "version": "1.0.2",
+    },
+    Object {
+      "version": "1.0.3",
+    },
+  ],
+}
+`;
diff --git a/lib/datasource/artifactory/common.ts b/lib/datasource/artifactory/common.ts
@@ -0,0 +1,3 @@
+export const defaultRegistryUrl = 'NOT-GIVEN-CUSTOM-REGISTRY'; // no public registry
+
+export const datasource = 'artifactory';
diff --git a/lib/datasource/artifactory/index.spec.ts b/lib/datasource/artifactory/index.spec.ts
@@ -0,0 +1,109 @@
+import { getPkgReleases } from '..';
+import * as httpMock from '../../../test/http-mock';
+import { loadFixture } from '../../../test/util';
+import { EXTERNAL_HOST_ERROR } from '../../constants/error-messages';
+import { logger as _logger } from '../../logger';
+import { ArtifactoryDatasource } from '.';
+
+const datasource = ArtifactoryDatasource.id;
+
+const testRegistryUrl = 'https://jfrog.company.com/artifactory';
+const testLookupName = 'project';
+const testConfig = {
+  registryUrls: [testRegistryUrl],
+  depName: testLookupName,
+};
+
+function getPath(folder: string): string {
+  return '/' + folder;
+}
+
+describe('datasource/artifactory/index', () => {
+  let logger: jest.Mocked<typeof _logger>;
+
+  beforeEach(async () => {
+    jest.mock('../../logger');
+    logger = (await import('../../logger')).logger as never;
+  });
+
+  describe('getReleases', () => {
+    it('parses real data (folders): with slash at the end', async () => {
+      httpMock
+        .scope(testRegistryUrl)
+        .get(getPath(testLookupName))
+        .reply(200, loadFixture('releases-as-folders.html'));
+      const res = await getPkgReleases({
+        ...testConfig,
+        datasource,
+        lookupName: testLookupName,
+      });
+      expect(res.releases).toHaveLength(4);
+      expect(res).toMatchSnapshot();
+    });
+
+    it('parses real data (files): without slash at the end', async () => {
+      httpMock
+        .scope(testRegistryUrl)
+        .get(getPath(testLookupName))
+        .reply(200, loadFixture('releases-as-files.html'));
+      const res = await getPkgReleases({
+        ...testConfig,
+        datasource,
+        lookupName: testLookupName,
+      });
+      expect(res.releases).toHaveLength(4);
+      expect(res).toMatchSnapshot();
+    });
+
+    it('returns null without registryUrl + warning', async () => {
+      jest.resetModules();
+      jest.resetAllMocks();
+      const res = await getPkgReleases({
+        datasource,
+        depName: testLookupName,
+        lookupName: testLookupName,
+      });
+      expect(logger.warn).toHaveBeenCalledTimes(1);
+      expect(logger.warn).toHaveBeenCalledWith(
+        'artifactory datasource requires custom registryUrl. Skipping datasource'
+      );
+      expect(res).toBeNull();
+    });
+
+    it('returns null for empty 200 OK', async () => {
+      httpMock
+        .scope(testRegistryUrl)
+        .get(getPath(testLookupName))
+        .reply(200, '<html>\n<h1>Header wo. nodes</h1>\n<hmtl/>');
+      expect(
+        await getPkgReleases({
+          ...testConfig,
+          datasource,
+          lookupName: testLookupName,
+        })
+      ).toBeNull();
+    });
+
+    it('throws for error diff than 404', async () => {
+      httpMock.scope(testRegistryUrl).get(getPath(testLookupName)).reply(502);
+      await expect(
+        getPkgReleases({
+          ...testConfig,
+          datasource,
+          lookupName: testLookupName,
+        })
+      ).rejects.toThrow(EXTERNAL_HOST_ERROR);
+    });
+
+    it('throws for 404', async () => {
+      httpMock.scope(testRegistryUrl).get(getPath(testLookupName)).reply(404);
+      expect(
+        await getPkgReleases({
+          ...testConfig,
+          datasource,
+          lookupName: testLookupName,
+        })
+      ).toBeNull();
+    });
+  });
+});
diff --git a/lib/datasource/artifactory/index.ts b/lib/datasource/artifactory/index.ts
@@ -0,0 +1,97 @@
+import { logger } from '../../logger';
+import { ExternalHostError } from '../../types/errors/external-host-error';
+import { cache } from '../../util/cache/package/decorator';
+import { parse } from '../../util/html';
+import { HttpError } from '../../util/http/types';
+import { Datasource } from '../datasource';
+import type { GetReleasesConfig, Release, ReleaseResult } from '../types';
+import { datasource, defaultRegistryUrl } from './common';
+
+export class ArtifactoryDatasource extends Datasource {
+  static readonly id = datasource;
+
+  constructor() {
+    super(datasource);
+  }
+
+  override readonly customRegistrySupport = true;
+
+  override readonly defaultRegistryUrls = [defaultRegistryUrl];
+
+  override readonly caching = true;
+
+  override readonly registryStrategy = 'merge';
+
+  @cache({
+    namespace: `datasource-${datasource}`,
+    key: ({ registryUrl }: GetReleasesConfig) => `${registryUrl}`,
+  })
+  async getReleases({
+    lookupName,
+    registryUrl,
+  }: GetReleasesConfig): Promise<ReleaseResult | null> {
+    if (registryUrl === defaultRegistryUrl) {
+      logger.warn(
+        'artifactory datasource requires custom registryUrl. Skipping datasource'
+      );
+      return null;
+    }
+
+    const url = `${registryUrl}/${lookupName}`;
+
+    const result: ReleaseResult = {
+      homepage: 'https://jfrog.com/artifactory',
+      releases: [],
+    };
+    try {
+      const response = await this.http.get(url);
+      const body = parse(ArtifactoryDatasource.cleanSimpleHtml(response.body));
+      const nodes = body.querySelectorAll('a');
+
+      let candidates: string[] = [];
+      nodes.forEach((node) => candidates.push(node.innerHTML));
+
+      // filter out hyperlink to navigate to parent folder
+      candidates = candidates.filter(
+        (candidate) => candidate !== '../' && candidate !== '..'
+      );
+
+      candidates.forEach((candidate) => {
+        const parsedCandidate: string =
+          candidate.slice(-1) === '/' ? candidate.slice(0, -1) : candidate;
+
+        const thisRelease: Release = {
+          version: '',
+        };
+        thisRelease.version = parsedCandidate;
+        result.releases.push(thisRelease);
+      });
+
+      if (result.releases.length) {
+        logger.debug('Found ' + String(result.releases.length) + ' releases');
+      } else {
+        logger.debug(
+          'Not found any version of ' + lookupName + ' under ' + url
+        );
+      }
+    } catch (err) {
+      // istanbul ignore else: not testable with nock
+      if (err instanceof HttpError) {
+        if (err.response?.statusCode !== 404) {
+          throw new ExternalHostError(err);
+        }
+      }
+      this.handleGenericErrors(err);
+    }
+
+    return result.releases.length ? result : null;
+  }
+
+  private static cleanSimpleHtml(html: string): string {
+    return (
+      html
+        // preformatted text hides the "a" nodes otherwise
+        .replace(/<\/?pre>/g, '')
+    );
+  }
+}
diff --git a/lib/datasource/artifactory/readme.md b/lib/datasource/artifactory/readme.md
@@ -0,0 +1,4 @@
+This datasource returns releases from given custom _registryUrl(s)_.
+
+The target url is composed by the _registryUrl_ and the _lookupName_,
+which defaults to _depName_ when _lookupName_ is not defined.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		export const defaultRegistryUrl = 'NOT-GIVEN-CUSTOM-REGISTRY'; // no public registry
rarkins marked this conversation as resolved. Show resolved Hide resolved

		export const datasource = 'artifactory';