rspec/frontend/src/deployment/__tests__/metadata.test.ts

import fs from 'fs';
import path from 'path';

import { generateOneRuleMetadata, generateRulesMetadata } from '../metadata';
import { withTestDir, createFiles } from '../testutils';

describe('metadata generation', () => {

  test('language specific metadata overrides generic metadata', () => {
    return withTestDir((srcPath) => {
      createFiles(srcPath, {
        'S100/metadata.json': JSON.stringify({
          title: 'Rule S100',
          tags: ['confusing']
        }),
        'S100/java/metadata.json': JSON.stringify({
          title: 'Java Rule S100'
        }),
        'S100/python/metadata.json': JSON.stringify({
          tags: ['pep8']
        }),
      });
      return withTestDir(async (dstPath) => {
        generateRulesMetadata(srcPath, dstPath);
        const javaStrMetadata = fs.readFileSync(`${dstPath}/S100/java-metadata.json`);
        const javaMetadata = JSON.parse(javaStrMetadata.toString());
        expect(javaMetadata).toMatchObject({
          title: 'Java Rule S100',
          tags: ['confusing']
        });
  
        const pythonStrMetadata = fs.readFileSync(`${dstPath}/S100/python-metadata.json`);
        const pythonMetadata = JSON.parse(pythonStrMetadata.toString());
        expect(pythonMetadata).toMatchObject({
          title: 'Rule S100',
          tags: ['pep8']
        });
      });
    });
  });

  test('check status computation', () => {
    return withTestDir((srcPath) => {
      createFiles(srcPath, {
        'S100/metadata.json': JSON.stringify({
          title: 'Rule S100',
          status: 'ready'
        }),
        'S100/java/metadata.json': JSON.stringify({
          title: 'Java Rule S100'
        }),
        'S100/python/metadata.json': JSON.stringify({
          status: 'closed'
        }),
      });
      return withTestDir(async (dstPath) => {
        generateRulesMetadata(srcPath, dstPath);
        const javaStrMetadata = fs.readFileSync(`${dstPath}/S100/java-metadata.json`);
        const pythonStrMetadata = fs.readFileSync(`${dstPath}/S100/python-metadata.json`);
        const javaMetadata = JSON.parse(javaStrMetadata.toString());
        const pythonMetadata = JSON.parse(pythonStrMetadata.toString());
        expect(pythonMetadata).toMatchObject({
          title: 'Rule S100',
          languagesSupport: [
            {name: 'java', status: 'ready'},
            {name: 'python', status: 'closed'}
          ]
        });

        expect(javaMetadata.languagesSupport).toStrictEqual(pythonMetadata.languagesSupport);
      });
    });
  });

  test('computes rule types correctly', () => {
    return withTestDir((srcPath) => {
      createFiles(srcPath, {
        'S100/metadata.json': JSON.stringify({
          title: 'Rule S100',
          type: 'CODE_SMELL',
        }),
        'S100/java/metadata.json': JSON.stringify({
          title: 'Java Rule S100',
        }),
        'S100/python/metadata.json': JSON.stringify({
          type: 'CODE_SMELL',
        }),
        'S100/cfamily/metadata.json': JSON.stringify({
          type: 'BUG',
        }),
      });

      return withTestDir(async (dstPath) => {
        generateRulesMetadata(srcPath, dstPath);

        const javaStrMetadata = fs.readFileSync(`${dstPath}/S100/java-metadata.json`);
        const pythonStrMetadata = fs.readFileSync(`${dstPath}/S100/python-metadata.json`);
        const cfamilyStrMetadata = fs.readFileSync(`${dstPath}/S100/cfamily-metadata.json`);
        const javaMetadata = JSON.parse(javaStrMetadata.toString());
        const pythonMetadata = JSON.parse(pythonStrMetadata.toString());
        const cfamilyMetadata = JSON.parse(cfamilyStrMetadata.toString());

        expect(javaMetadata).toMatchObject({
          title: 'Java Rule S100',
          type: 'CODE_SMELL',
        });

        expect(pythonMetadata).toMatchObject({
          title: 'Rule S100',
          type: 'CODE_SMELL',
        });

        expect(cfamilyMetadata).toMatchObject({
          title: 'Rule S100',
          type: 'BUG',
        });
      });
    });
  });

  test('generates only requested rules if a list of rule is provided', () => {
    return withTestDir((srcPath) => {
      createFiles(srcPath, {
        'S100/java/metadata.json': JSON.stringify({
          title: 'Rule S100'
        }),
        'S200/java/metadata.json': JSON.stringify({
          title: 'Rule S200'
        }),
      });
      return withTestDir(async (dstPath) => {
        generateRulesMetadata(srcPath, dstPath, ['S100']);

        const s100Exists = fs.existsSync(`${dstPath}/S100/java-metadata.json`);
        expect(s100Exists).toBeTruthy();
    
        const s200Exists = fs.existsSync(`${dstPath}/S200/java-metadata.json`);
        expect(s200Exists).toBeFalsy();
      });
    });
  });

  test('forwards the pr url when provided', () => {
    return withTestDir((srcPath) => {
      createFiles(srcPath, {
        'S100/java/metadata.json': JSON.stringify({
          title: 'Rule S100'
        }),
        'S200/java/metadata.json': JSON.stringify({
          title: 'Rule S200'
        }),
      });
      return withTestDir(async (dstPath) => {
        generateOneRuleMetadata(path.join(srcPath, 'S100'), path.join(dstPath, 'S100'), 'master');

        const s100StrMetadata = fs.readFileSync(`${dstPath}/S100/java-metadata.json`);
        const s100Metadata = JSON.parse(s100StrMetadata.toString());
        expect(Object.keys(s100Metadata)).toContain('branch');
        expect(s100Metadata.branch).toEqual('master');
        expect(Object.keys(s100Metadata)).not.toContain('prUrl');

        generateOneRuleMetadata(path.join(srcPath, 'S200'), path.join(dstPath, 'S200'), 'add-my-rule', 'https://some.pr/url');


        const s200StrMetadata = fs.readFileSync(`${dstPath}/S200/java-metadata.json`);
        const s200Metadata = JSON.parse(s200StrMetadata.toString());
        expect(Object.keys(s200Metadata)).toContain('prUrl');
        expect(s200Metadata.branch).toEqual('add-my-rule');
        expect(s200Metadata.prUrl).toEqual('https://some.pr/url');
      });
    });
  });

  test('generates metadata for active rules', () => {
    return withTestDir(async (dstPath) => {
      generateRulesMetadata(path.join(__dirname, 'resources', 'rules'), dstPath);
      const rules = fs.readdirSync(dstPath);
      expect(rules.length).toEqual(5);
      let treated = 0;
      rules.forEach(ruleDir => {
        const languages = fs.readdirSync(`${dstPath}/${ruleDir}`);
        expect(languages.length).toBeGreaterThanOrEqual(1);
        languages.forEach(file => {
          const actual = JSON.parse(fs.readFileSync(`${dstPath}/${ruleDir}/${file}`).toString());
          const expectedPath = path.join(__dirname, 'resources', 'metadata', ruleDir, file);
          const expected = JSON.parse(fs.readFileSync(expectedPath).toString());
          expect(actual).toStrictEqual(expected);
          treated++;
        })
      });
      expect(treated).toBe(13);
    });
  });

  test('generates metadata for closed rules', () => {
    return withTestDir(srcPath => {
      createFiles(srcPath, {
        'S01/metadata.json': JSON.stringify({
          title: 'Rule is closed and has no language-specific specification',
          type: 'CODE_SMELL',
          status: 'closed',
          sqKey: 'S01',
          extra: {
            legacyKeys: ['OldS01'],
          },
        }),

        'S02/metadata.json': JSON.stringify({
          title: 'Rule is closed and has one closed language-specific specification',
          type: 'CODE_SMELL',
          status: 'closed',
          sqKey: 'S02',
        }),
        'S02/cfamily/metadata.json': JSON.stringify({
          title: 'Language specification is closed',
          status: 'closed',
          extra: {
            legacyKeys: ['OldS02'],
          },
        }),
      });

      return withTestDir(async dstPath => {
        generateRulesMetadata(srcPath, dstPath);

        const rules = fs.readdirSync(dstPath).sort();
        expect(rules).toEqual(['S01', 'S02'].sort());

        {
          const rule = 'S01';
          const rulePath = path.join(dstPath, rule);
          // Verify that the expected files are generated and no others
          const entries = fs.readdirSync(rulePath).sort();
          expect(entries).toEqual(['default-metadata.json'].sort());

          // Check the top-level metadata
          const defaultFile = path.join(rulePath, 'default-metadata.json');
          const defaultData = JSON.parse(fs.readFileSync(defaultFile, 'utf8'));
          expect(defaultData).toMatchObject({
            title: 'Rule is closed and has no language-specific specification',
            type: 'CODE_SMELL',
            status: 'closed',
            languagesSupport: [],
            allKeys: ['S01', 'OldS01'],
          });
        }

        {
          const rule = 'S02';
          const rulePath = path.join(dstPath, rule);
          // Verify that the expected files are generated and no others
          const entries = fs.readdirSync(rulePath).sort();
          expect(entries).toEqual(['default-metadata.json', 'cfamily-metadata.json'].sort());

          // Check the top-level metadata
          const defaultFile = path.join(rulePath, 'default-metadata.json');
          const defaultData = JSON.parse(fs.readFileSync(defaultFile, 'utf8'));
          // Generic data is overriden by the first language-specific specification.
          expect(defaultData).toMatchObject({
            title: 'Language specification is closed',
            type: 'CODE_SMELL',
            status: 'closed',
            languagesSupport: [{ name: 'cfamily', status: 'closed', }],
            allKeys: ['S02', 'OldS02'],
          });

          // Check the language-specific metadata
          const cfamilyFile = path.join(rulePath, 'cfamily-metadata.json');
          const cfamilyData = JSON.parse(fs.readFileSync(cfamilyFile, 'utf8'));
          expect(cfamilyData).toMatchObject({
            title: 'Language specification is closed',
            type: 'CODE_SMELL',
            status: 'closed',
            languagesSupport: [{ name: 'cfamily', status: 'closed', }],
            allKeys: ['S02', 'OldS02'],
          });
        }
      });
    });
  });
});