Skip to content

Commit

Permalink
[build] Migrate grunt license:csv_report to script (#86001)
Browse files Browse the repository at this point in the history
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
  • Loading branch information
jbudz and kibanamachine committed Jan 13, 2021
1 parent 59f223d commit f664621
Show file tree
Hide file tree
Showing 3 changed files with 149 additions and 116 deletions.
21 changes: 21 additions & 0 deletions scripts/licenses_csv_report.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

require('../src/setup_node_env');
require('../src/dev/run_licenses_csv_report');
128 changes: 128 additions & 0 deletions src/dev/run_licenses_csv_report.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { writeFileSync } from 'fs';
import { resolve } from 'path';
import { isNull, isUndefined } from 'lodash';

import { run } from '@kbn/dev-utils';

import { getInstalledPackages } from './npm';
import { engines } from '../../package';
import { LICENSE_OVERRIDES } from './license_checker';

const allDoubleQuoteRE = /"/g;

function escapeValue(value) {
if (isNull(value)) {
return;
}

return `"${value.replace(allDoubleQuoteRE, '""')}"`;
}

function formatCsvValues(fields, values) {
return fields
.map((field) => {
const value = values[field];

if (isNull(value) || isUndefined(value)) {
return null;
}

return value.toString();
})
.map(escapeValue)
.join(',');
}

run(
async ({ log, flags }) => {
const fields = ['name', 'version', 'url', 'license', 'sourceURL'];

const file = flags.csv;
const directory = flags.directory;
const dev = flags.dev;

const root = resolve(__dirname, '..', '..');
const packages = await getInstalledPackages({
directory: directory ? resolve(directory) : root,
licenseOverrides: LICENSE_OVERRIDES,
dev,
});

packages.unshift(
{
name: 'Node.js',
version: engines.node,
repository: 'https://nodejs.org',
licenses: ['MIT'],
},
{
name: 'Red Hat Universal Base Image minimal',
version: '8',
repository:
'https://catalog.redhat.com/software/containers/ubi8/ubi-minimal/5c359a62bed8bd75a2c3fba8',
licenses: [
'Custom;https://www.redhat.com/licenses/EULA_Red_Hat_Universal_Base_Image_English_20190422.pdf',
],
sourceURL: 'https://oss-dependencies.elastic.co/redhat/ubi/ubi-minimal-8-source.tar.gz',
}
);

const csv = packages
.map((pkg) => {
const data = {
name: pkg.name,
version: pkg.version,
url: pkg.repository || `https://www.npmjs.com/package/${pkg.name}`,
license: pkg.licenses.join(','),
sourceURL: pkg.sourceURL,
};

return formatCsvValues(fields, data);
})
.join('\n');

if (file) {
writeFileSync(file, `${fields.join(',')}\n${csv}`);
log.success(`wrote to ${file}`);
} else {
log.success(csv);
log.debug('\nspecify "--csv [filepath]" to write the data to a specific file');
}
},
{
description: `
Report of 3rd party dependencies
`,
flags: {
boolean: ['dev'],
string: ['csv', 'directory'],
default: {
dev: false,
},
help: `
--dev Include development dependencies
--csv Write csv report to file
--directory Directory to check for licenses
`,
},
}
);
116 changes: 0 additions & 116 deletions tasks/licenses_csv_report.js

This file was deleted.

0 comments on commit f664621

Please sign in to comment.