dummy implementation for puppet

lib/modules/datasource/api.ts

@@ -31,6 +31,7 @@ import { NugetDatasource } from './nuget';
 import { OrbDatasource } from './orb';
 import { PackagistDatasource } from './packagist';
 import { PodDatasource } from './pod';
+import { PuppetDatasource } from './puppet';
 import { PypiDatasource } from './pypi';
 import { RepologyDatasource } from './repology';
 import { RubyVersionDatasource } from './ruby-version';
@@ -77,6 +78,7 @@ api.set(NugetDatasource.id, new NugetDatasource());
 api.set(OrbDatasource.id, new OrbDatasource());
 api.set(PackagistDatasource.id, new PackagistDatasource());
 api.set(PodDatasource.id, new PodDatasource());
+api.set(PuppetDatasource.id, new PuppetDatasource());
 api.set(PypiDatasource.id, new PypiDatasource());
 api.set(RepologyDatasource.id, new RepologyDatasource());
 api.set(RubyVersionDatasource.id, new RubyVersionDatasource());

lib/modules/datasource/puppet/__fixtures__/puppetforge-response.json

@@ -0,0 +1,66 @@
+{
+  "uri": "/v3/modules/puppetlabs-apache",
+  "slug": "puppetlabs-apache",
+  "name": "apache",
+  "downloads": 11063567,
+  "created_at": "2010-05-20 22:43:19 -0700",
+  "updated_at": "2021-10-11 07:47:24 -0700",
+  "deprecated_at": null,
+  "deprecated_for": null,
+  "superseded_by": null,
+  "supported": true,
+  "endorsement": "supported",
+  "module_group": "base",
+  "owner": {
+    "uri": "/v3/users/puppetlabs",
+    "slug": "puppetlabs",
+    "username": "puppetlabs",
+    "gravatar_id": "fdd009b7c1ec96e088b389f773e87aec"
+  },
+  "premium": false,
+  "releases": [
+    {
+      "uri": "/v3/releases/puppetlabs-apache-7.0.0",
+      "slug": "puppetlabs-apache-7.0.0",
+      "version": "7.0.0",
+      "supported": false,
+      "created_at": "2021-10-11 07:47:24 -0700",
+      "deleted_at": null,
+      "file_uri": "/v3/files/puppetlabs-apache-7.0.0.tar.gz",
+      "file_size": 331833
+    },
+    {
+      "uri": "/v3/releases/puppetlabs-apache-6.5.1",
+      "slug": "puppetlabs-apache-6.5.1",
+      "version": "6.5.1",
+      "supported": false,
+      "created_at": "2021-08-25 04:16:27 -0700",
+      "deleted_at": null,
+      "file_uri": "/v3/files/puppetlabs-apache-6.5.1.tar.gz",
+      "file_size": 331386
+    },
+    {
+      "uri": "/v3/releases/puppetlabs-apache-6.5.0",
+      "slug": "puppetlabs-apache-6.5.0",
+      "version": "6.5.0",
+      "supported": false,
+      "created_at": "2021-08-24 08:20:22 -0700",
+      "deleted_at": null,
+      "file_uri": "/v3/files/puppetlabs-apache-6.5.0.tar.gz",
+      "file_size": 331330
+    },
+    {
+      "uri": "/v3/releases/puppetlabs-apache-6.4.0",
+      "slug": "puppetlabs-apache-6.4.0",
+      "version": "6.4.0",
+      "supported": false,
+      "created_at": "2021-08-02 06:49:41 -0700",
+      "deleted_at": null,
+      "file_uri": "/v3/files/puppetlabs-apache-6.4.0.tar.gz",
+      "file_size": 331201
+    }
+  ],
+  "feedback_score": 83,
+  "homepage_url": "https://github.com/puppetlabs/puppetlabs-apache",
+  "issues_url": "https://tickets.puppetlabs.com/browse/MODULES"
+}

lib/modules/datasource/puppet/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,149 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`modules/datasource/puppet/index getReleases parses real data 1`] = `
+Object {
+  "deprecationMessage": null,
+  "registryUrl": "https://forgeapi.puppet.com",
+  "releases": Array [
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-6.4.0.tar.gz",
+      "registryUrl": "https://forgeapi.puppet.com",
+      "releaseTimestamp": "2021-08-02T13:49:41.000Z",
+      "version": "6.4.0",
+    },
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-6.5.0.tar.gz",
+      "registryUrl": "https://forgeapi.puppet.com",
+      "releaseTimestamp": "2021-08-24T15:20:22.000Z",
+      "version": "6.5.0",
+    },
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-6.5.1.tar.gz",
+      "registryUrl": "https://forgeapi.puppet.com",
+      "releaseTimestamp": "2021-08-25T11:16:27.000Z",
+      "version": "6.5.1",
+    },
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-7.0.0.tar.gz",
+      "registryUrl": "https://forgeapi.puppet.com",
+      "releaseTimestamp": "2021-10-11T14:47:24.000Z",
+      "version": "7.0.0",
+    },
+  ],
+  "sourceUrl": "https://github.com/puppetlabs/puppetlabs-apache",
+  "tags": Object {
+    "endorsement": "supported",
+    "moduleGroup": "base",
+    "premium": "false",
+  },
+}
+`;
+
+exports[`modules/datasource/puppet/index getReleases parses real data 2`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate, br",
+      "host": "forgeapi.puppet.com",
+      "user-agent": "RenovateBot/0.0.0-semantic-release (https://github.com/renovatebot/renovate)",
+    },
+    "method": "GET",
+    "url": "https://forgeapi.puppet.com/v3/modules/puppetlabs-apache",
+  },
+]
+`;
+
+exports[`modules/datasource/puppet/index should fetch package info from custom registry 1`] = `
+Object {
+  "deprecationMessage": null,
+  "registryUrl": "https://puppet.mycustomregistry.com",
+  "releases": Array [
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-6.4.0.tar.gz",
+      "registryUrl": "https://puppet.mycustomregistry.com",
+      "releaseTimestamp": "2021-08-02T13:49:41.000Z",
+      "version": "6.4.0",
+    },
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-6.5.0.tar.gz",
+      "registryUrl": "https://puppet.mycustomregistry.com",
+      "releaseTimestamp": "2021-08-24T15:20:22.000Z",
+      "version": "6.5.0",
+    },
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-6.5.1.tar.gz",
+      "registryUrl": "https://puppet.mycustomregistry.com",
+      "releaseTimestamp": "2021-08-25T11:16:27.000Z",
+      "version": "6.5.1",
+    },
+    Object {
+      "downloadUrl": "/v3/files/puppetlabs-apache-7.0.0.tar.gz",
+      "registryUrl": "https://puppet.mycustomregistry.com",
+      "releaseTimestamp": "2021-10-11T14:47:24.000Z",
+      "version": "7.0.0",
+    },
+  ],
+  "sourceUrl": "https://github.com/puppetlabs/puppetlabs-apache",
+  "tags": Object {
+    "endorsement": "supported",
+    "moduleGroup": "base",
+    "premium": "false",
+  },
+}
+`;
+
+exports[`modules/datasource/puppet/index should fetch package info from custom registry 2`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate, br",
+      "host": "puppet.mycustomregistry.com",
+      "user-agent": "RenovateBot/0.0.0-semantic-release (https://github.com/renovatebot/renovate)",
+    },
+    "method": "GET",
+    "url": "https://puppet.mycustomregistry.com/v3/modules/foobar",
+  },
+]
+`;
+
+exports[`modules/datasource/puppet/index should return null if lookup fails 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate, br",
+      "host": "forgeapi.puppet.com",
+      "user-agent": "RenovateBot/0.0.0-semantic-release (https://github.com/renovatebot/renovate)",
+    },
+    "method": "GET",
+    "url": "https://forgeapi.puppet.com/v3/modules/foobar",
+  },
+]
+`;
+
+exports[`modules/datasource/puppet/index should return null if lookup fails 400 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate, br",
+      "host": "forgeapi.puppet.com",
+      "user-agent": "RenovateBot/0.0.0-semantic-release (https://github.com/renovatebot/renovate)",
+    },
+    "method": "GET",
+    "url": "https://forgeapi.puppet.com/v3/modules/foobar",
+  },
+]
+`;
+
+exports[`modules/datasource/puppet/index should return null if lookup fails 401 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate, br",
+      "host": "forgeapi.puppet.com",
+      "user-agent": "RenovateBot/0.0.0-semantic-release (https://github.com/renovatebot/renovate)",
+    },
+    "method": "GET",
+    "url": "https://forgeapi.puppet.com/v3/modules/foobar",
+  },
+]
+`;

lib/modules/datasource/puppet/index.spec.ts

@@ -0,0 +1,83 @@
+import { getPkgReleases } from '..';
+import * as httpMock from '../../../../test/http-mock';
+import { loadFixture } from '../../../../test/util';
+import { PuppetDatasource } from './index';
+
+const puppetforgeReleases = loadFixture('puppetforge-response.json');
+
+const datasource = PuppetDatasource.id;
+
+describe('modules/datasource/puppet/index', () => {
+  describe('getReleases', () => {
+    it('parses real data', async () => {
+      httpMock
+        .scope('https://forgeapi.puppet.com')
+        .get('/v3/modules/puppetlabs-apache')
+        .reply(200, puppetforgeReleases);
+
+      const res = await getPkgReleases({
+        datasource,
+        depName: 'puppetlabs/apache',
+        packageName: 'puppetlabs/apache',
+        registryUrls: ['https://forgeapi.puppet.com'],
+      });
+      const release = res.releases[res.releases.length - 1];
+
+      expect(res.releases).toHaveLength(4);
+      expect(release.version).toBe('7.0.0');
+      expect(release.downloadUrl).toBe(
+        '/v3/files/puppetlabs-apache-7.0.0.tar.gz'
+      );
+      expect(release.releaseTimestamp).toBe('2021-10-11T14:47:24.000Z');
+      expect(release.registryUrl).toBe('https://forgeapi.puppet.com');
+      expect(res).toMatchSnapshot();
+      expect(res.sourceUrl).toBeDefined();
+      expect(httpMock.getTrace()).toMatchSnapshot();
+    });
+  });
+
+  // https://forgeapi.puppet.com/#operation/getModule
+  it('should return null if lookup fails 400', async () => {
+    httpMock
+      .scope('https://forgeapi.puppet.com')
+      .get('/v3/modules/foobar')
+      .reply(400);
+    const res = await getPkgReleases({
+      datasource,
+      depName: 'foobar',
+      registryUrls: ['https://forgeapi.puppet.com'],
+    });
+    expect(res).toBeNull();
+    expect(httpMock.getTrace()).toMatchSnapshot();
+  });
+
+  // https://forgeapi.puppet.com/#operation/getModule
+  it('should return null if lookup fails', async () => {
+    httpMock
+      .scope('https://forgeapi.puppet.com')
+      .get('/v3/modules/foobar')
+      .reply(404);
+    const res = await getPkgReleases({
+      datasource,
+      depName: 'foobar',
+      registryUrls: ['https://forgeapi.puppet.com'],
+    });
+    expect(res).toBeNull();
+    expect(httpMock.getTrace()).toMatchSnapshot();
+  });
+
+  it('should fetch package info from custom registry', async () => {
+    httpMock
+      .scope('https://puppet.mycustomregistry.com', {})
+      .get('/v3/modules/foobar')
+      .reply(200, puppetforgeReleases);
+    const registryUrls = ['https://puppet.mycustomregistry.com'];
+    const res = await getPkgReleases({
+      datasource,
+      depName: 'foobar',
+      registryUrls,
+    });
+    expect(res).toMatchSnapshot();
+    expect(httpMock.getTrace()).toMatchSnapshot();
+  });
+});

lib/modules/datasource/puppet/index.ts

@@ -0,0 +1,52 @@
+import { logger } from '../../../logger';
+import { Datasource } from '../datasource';
+import type { GetReleasesConfig, Release, ReleaseResult } from '../types';
+import type { PuppetModule } from './types';
+
+export class PuppetDatasource extends Datasource {
+  static id = 'puppet';
+
+  constructor() {
+    super(PuppetDatasource.id);
+  }
+
+  async getReleases({
+    packageName,
+    registryUrl,
+  }: GetReleasesConfig): Promise<ReleaseResult | null> {
+    // https://forgeapi.puppet.com
+    const moduleSlug = packageName.replace('/', '-');
+    const url = `${registryUrl}/v3/modules/${moduleSlug}`;
+
+    let moduleResponse;
+    try {
+      moduleResponse = await this.http.get(url);
+    } catch (e) {
+      logger.warn(
+        `ignore dependency ${packageName} because of faulty response for ${url}: ${e}`
+      );
+      return null;
+    }
+
+    const module: PuppetModule = JSON.parse(moduleResponse.body);
+
+    const releases: Release[] = module.releases.map((release) => ({
+      version: release.version,
+      downloadUrl: release.file_uri,
+      releaseTimestamp: release.created_at,
+      registryUrl,
+    }));
+
+    return {
+      releases,
+      deprecationMessage: module.deprecated_for,
+      homepage: module.homepage_url,
+      tags: {
+        // is this the correct use of tags?
+        endorsement: module.endorsement,
+        moduleGroup: module.module_group,
+        premium: `${module.premium}`,
+      },
+    };
+  }
+}