forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[build] Migrate grunt license:csv_report to script
Part of a larger effort to remove our grunt depedencies, elastic#85341.
- Loading branch information
Showing
2 changed files
with
155 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
/* | ||
* 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']; | ||
|
||
try { | ||
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'); | ||
} | ||
} catch (err) { | ||
process.exitCode = 1; | ||
log.error(err); | ||
return err; | ||
} | ||
}, | ||
{ | ||
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 | ||
`, | ||
}, | ||
} | ||
); |