renovate/lib/modules/datasource/puppet-forge/index.spec.ts

import { Fixtures } from '~test/fixtures.ts';
import * as httpMock from '~test/http-mock.ts';
import { getPkgReleases } from '../index.ts';
import { PuppetForgeDatasource } from './index.ts';

const puppetforgeReleases = Fixtures.get('puppetforge-response.json');

const datasource = PuppetForgeDatasource.id;

describe('modules/datasource/puppet-forge/index', () => {
  describe('getReleases', () => {
    it('should use default forge if no other provided', async () => {
      httpMock
        .scope('https://forgeapi.puppet.com')
        .get('/v3/modules/puppetlabs-apache')
        .query({ exclude_fields: 'current_release' })
        .reply(200, puppetforgeReleases);

      const res = await getPkgReleases({
        datasource,
        packageName: 'puppetlabs/apache',
      });
      expect(res).toMatchObject({
        registryUrl: 'https://forgeapi.puppet.com',
        releases: [
          { version: '6.4.0' },
          { version: '6.5.0' },
          { version: '6.5.1' },
          { version: '7.0.0' },
        ],
      });
    });

    it('parses real data', async () => {
      httpMock
        .scope('https://forgeapi.puppet.com')
        .get('/v3/modules/puppetlabs-apache')
        .query({ exclude_fields: 'current_release' })
        .reply(200, puppetforgeReleases);

      const res = await getPkgReleases({
        datasource,
        packageName: 'puppetlabs/apache',
        registryUrls: ['https://forgeapi.puppet.com'],
      });

      expect(res).toEqual({
        registryUrl: 'https://forgeapi.puppet.com',
        releases: [
          {
            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',
          },
          {
            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',
          },
          {
            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',
          },
          {
            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',
      });
    });

    it('has a deprecated for reason', async () => {
      httpMock
        .scope('https://forgeapi.puppet.com')
        .get('/v3/modules/puppetlabs-apache')
        .query({ exclude_fields: 'current_release' })
        .reply(200, Fixtures.get('puppetforge-deprecated-for.json'));

      const res = await getPkgReleases({
        datasource,
        packageName: 'puppetlabs/apache',
      });
      expect(res).toEqual({
        deprecationMessage: 'use another module ...',
        registryUrl: 'https://forgeapi.puppet.com',
        releases: [
          {
            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',
      });
    });
  });

  // 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')
      .query({ exclude_fields: 'current_release' })
      .reply(400);

    const res = await getPkgReleases({
      datasource,
      packageName: 'foobar',
      registryUrls: ['https://forgeapi.puppet.com'],
    });
    expect(res).toBeNull();
  });

  // https://forgeapi.puppet.com/#operation/getModule
  it('should return null if lookup fails', async () => {
    httpMock
      .scope('https://forgeapi.puppet.com')
      .get('/v3/modules/foobar')
      .query({ exclude_fields: 'current_release' })
      .reply(404);
    const res = await getPkgReleases({
      datasource,
      packageName: 'foobar',
      registryUrls: ['https://forgeapi.puppet.com'],
    });
    expect(res).toBeNull();
  });

  it('should fetch package info from custom registry', async () => {
    httpMock
      .scope('https://puppet.mycustomregistry.com', {})
      .get('/v3/modules/foobar')
      .query({ exclude_fields: 'current_release' })
      .reply(200, puppetforgeReleases);
    const registryUrls = ['https://puppet.mycustomregistry.com'];
    const res = await getPkgReleases({
      datasource,
      packageName: 'foobar',
      registryUrls,
    });

    expect(res).toEqual({
      registryUrl: 'https://puppet.mycustomregistry.com',
      releases: [
        {
          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',
        },
        {
          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',
        },
        {
          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',
        },
        {
          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',
    });
  });

  it('load all possible null values', async () => {
    httpMock
      .scope('https://forgeapi.puppet.com', {})
      .get('/v3/modules/foobar')
      .query({ exclude_fields: 'current_release' })
      .reply(200, Fixtures.get('puppetforge-response-with-nulls.json'));

    const res = await getPkgReleases({
      datasource,
      packageName: 'foobar',
    });

    expect(res).toEqual({
      registryUrl: 'https://forgeapi.puppet.com',
      releases: [
        {
          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',
    });
  });

  it('no releases available -> return null', async () => {
    httpMock
      .scope('https://forgeapi.puppet.com', {})
      .get('/v3/modules/foobar')
      .query({ exclude_fields: 'current_release' })
      .reply(200, Fixtures.get('puppetforge-no-releases.json'));

    const res = await getPkgReleases({
      datasource,
      packageName: 'foobar',
    });

    expect(res).toBeNull();
  });

  it('only deleted releases available -> return null', async () => {
    httpMock
      .scope('https://forgeapi.puppet.com', {})
      .get('/v3/modules/foobar')
      .query({ exclude_fields: 'current_release' })
      .reply(200, {
        releases: [
          {
            version: '1.0.0',
            created_at: '2021-10-11 07:47:24 -0700',
            deleted_at: '2021-10-12 07:47:24 -0700',
          },
        ],
      });

    const res = await getPkgReleases({
      datasource,
      packageName: 'foobar',
    });

    expect(res).toBeNull();
  });
});