You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
387 lines
10 KiB
387 lines
10 KiB
|
|
/*
|
|
Utilities for generating & managing mock projects to test plugins.
|
|
*/
|
|
|
|
const path = require('path');
|
|
const fs = require('fs');
|
|
const shell = require('shelljs');
|
|
const decache = require('decache');
|
|
const globalModules = require('global-modules');
|
|
|
|
const TruffleConfig = require('truffle-config');
|
|
|
|
const { HARDHAT_NETWORK_NAME } = require("hardhat/plugins")
|
|
const { resetHardhatContext } = require("hardhat/plugins-testing")
|
|
const { resetBuidlerContext } = require("@nomiclabs/buidler/plugins-testing")
|
|
|
|
const temp = './sc_temp';
|
|
const truffleConfigName = 'truffle-config.js';
|
|
const buidlerConfigName = 'buidler.config.js';
|
|
const hardhatConfigName = 'hardhat.config.js';
|
|
const configPath = `${temp}/.solcover.js`;
|
|
const testPath = './test/sources/js/';
|
|
const sourcesPath = './test/sources/solidity/contracts/app/';
|
|
const migrationPath = `${temp}/migrations/2_deploy.js`;
|
|
const templatePath = './test/integration/generic/*';
|
|
const projectPath = './test/integration/projects/'
|
|
|
|
let previousCWD;
|
|
|
|
// ==========================
|
|
// Misc Utils
|
|
// ==========================
|
|
function decacheConfigs(){
|
|
const paths = [
|
|
`${process.cwd()}/${temp}/.solcover.js`,
|
|
`${process.cwd()}/${temp}/${truffleConfigName}`,
|
|
`${process.cwd()}/${temp}/${buidlerConfigName}`,
|
|
`${process.cwd()}/${temp}/${hardhatConfigName}`,
|
|
`${process.cwd()}/${temp}/contracts/Simple.sol`,
|
|
`${process.cwd()}/${temp}/test/simple.js`,
|
|
`${process.cwd()}/${temp}/test/account-one.js`,
|
|
`${process.cwd()}/${temp}/test/truffle-crash.js`
|
|
];
|
|
|
|
paths.forEach(pth => {
|
|
try { decache(pth) } catch (e){}
|
|
});
|
|
}
|
|
|
|
function clean() {
|
|
shell.config.silent = true;
|
|
|
|
shell.rm('-Rf', temp);
|
|
shell.rm('-Rf', 'coverage');
|
|
shell.rm('coverage.json');
|
|
shell.rm('.solcover.js');
|
|
|
|
shell.config.silent = false;
|
|
};
|
|
|
|
function pathToContract(config, file) {
|
|
return path.join('contracts', file);
|
|
}
|
|
|
|
function pathToTemp(_path) {
|
|
return path.join(temp, _path);
|
|
}
|
|
|
|
function getOutput(config){
|
|
const workingDir = config.working_directory || config.paths.root;
|
|
const jsonPath = path.join(workingDir, "coverage.json");
|
|
return JSON.parse(fs.readFileSync(jsonPath, 'utf8'));
|
|
}
|
|
|
|
// Buidler env set up
|
|
function buidlerSetupEnv(mocha) {
|
|
const mockwd = path.join(process.cwd(), temp);
|
|
previousCWD = process.cwd();
|
|
process.chdir(mockwd);
|
|
mocha.env = require("@nomiclabs/buidler");
|
|
mocha.env.config.logger = testLogger
|
|
mocha.logger = testLogger
|
|
};
|
|
|
|
// Hardhat env set up
|
|
function hardhatSetupEnv(mocha) {
|
|
const mockwd = path.join(process.cwd(), temp);
|
|
previousCWD = process.cwd();
|
|
process.chdir(mockwd);
|
|
mocha.env = require("hardhat");
|
|
mocha.env.config.logger = testLogger
|
|
mocha.logger = testLogger
|
|
};
|
|
|
|
// Buidler env tear down
|
|
function buidlerTearDownEnv() {
|
|
resetBuidlerContext();
|
|
process.chdir(previousCWD);
|
|
};
|
|
|
|
// Hardhat env tear down
|
|
function hardhatTearDownEnv() {
|
|
resetHardhatContext();
|
|
process.chdir(previousCWD); // remove?
|
|
};
|
|
|
|
|
|
// ==========================
|
|
// Truffle Configuration
|
|
// ==========================
|
|
function getDefaultTruffleConfig(){
|
|
const logger = process.env.SILENT ? { log: () => {} } : console;
|
|
const reporter = process.env.SILENT ? 'dot' : 'spec';
|
|
|
|
const mockwd = path.join(process.cwd(), temp);
|
|
const vals = {
|
|
working_directory: mockwd,
|
|
build_directory: path.join(mockwd, 'build'),
|
|
contracts_directory: path.join(mockwd, 'contracts'),
|
|
contracts_build_directory: path.join(mockwd, 'build', 'contracts'),
|
|
migrations_directory: path.join(mockwd, 'migrations'),
|
|
test_directory: path.join(mockwd, 'test'),
|
|
logger: logger,
|
|
mocha: { reporter: reporter },
|
|
networks: {
|
|
development: {
|
|
host: "localhost",
|
|
port: 8545,
|
|
network_id: "*"
|
|
}
|
|
},
|
|
compilers: {
|
|
solc: {
|
|
version: "0.7.1",
|
|
settings: { optimizer: {} }
|
|
}
|
|
}
|
|
}
|
|
|
|
return (new TruffleConfig()).with(vals);
|
|
}
|
|
|
|
function getTruffleConfigJS(config){
|
|
if (config) {
|
|
return `module.exports = ${JSON.stringify(config, null, ' ')}`;
|
|
} else {
|
|
return `module.exports = ${JSON.stringify(getDefaultTruffleConfig(), null, ' ')}`;
|
|
}
|
|
}
|
|
|
|
// ==========================
|
|
// NomicLab Configuration
|
|
// ==========================
|
|
function getDefaultNomicLabsConfig(){
|
|
const logger = process.env.SILENT ? { log: () => {} } : console;
|
|
const reporter = process.env.SILENT ? 'dot' : 'spec';
|
|
|
|
const mockwd = path.join(process.cwd(), temp);
|
|
const vals = {
|
|
paths : {
|
|
root: mockwd,
|
|
artifacts: path.join(mockwd, 'artifacts'),
|
|
cache: path.join(mockwd, 'cache'),
|
|
sources: path.join(mockwd, 'contracts'),
|
|
tests: path.join(mockwd, 'test'),
|
|
},
|
|
logger: logger,
|
|
mocha: {
|
|
reporter: reporter
|
|
},
|
|
networks: {
|
|
development: {
|
|
url: "http://127.0.0.1:8545",
|
|
}
|
|
}
|
|
}
|
|
|
|
return vals;
|
|
}
|
|
|
|
function getDefaultBuidlerConfig() {
|
|
const config = getDefaultNomicLabsConfig()
|
|
config.defaultNetwork = "buidlerevm";
|
|
config.solc = {
|
|
version: "0.7.3",
|
|
evmVersion: 'petersburg'
|
|
}
|
|
|
|
return config;
|
|
}
|
|
|
|
function getDefaultHardhatConfig() {
|
|
const config = getDefaultNomicLabsConfig()
|
|
config.defaultNetwork = HARDHAT_NETWORK_NAME;
|
|
config.solidity = {
|
|
version: "0.7.3"
|
|
}
|
|
return config;
|
|
}
|
|
|
|
function getBuidlerConfigJS(config){
|
|
// Hardhat tests will crash if the buidler plugin is loaded from the shared entrypoint
|
|
// b/c of some kind of weird cacheing or context reset issue.
|
|
const prefix =`
|
|
const { loadPluginFile } = require("@nomiclabs/buidler/plugins-testing");
|
|
loadPluginFile(__dirname + "/../plugins/buidler.plugin");
|
|
usePlugin("@nomiclabs/buidler-truffle5");
|
|
`
|
|
|
|
if (config) {
|
|
return `${prefix}module.exports = ${JSON.stringify(config, null, ' ')}`;
|
|
} else {
|
|
return `${prefix}module.exports = ${JSON.stringify(getDefaultBuidlerConfig(), null, ' ')}`;
|
|
}
|
|
}
|
|
|
|
function getHardhatConfigJS(config){
|
|
const prefix =`
|
|
require("@nomiclabs/hardhat-truffle5");
|
|
require(__dirname + "/../plugins/nomiclabs.plugin");
|
|
|
|
`
|
|
|
|
if (config) {
|
|
return `${prefix}module.exports = ${JSON.stringify(config, null, ' ')}`;
|
|
} else {
|
|
return `${prefix}module.exports = ${JSON.stringify(getDefaultHardhatConfig(), null, ' ')}`;
|
|
}
|
|
}
|
|
|
|
// ==========================
|
|
// .solcover.js Configuration
|
|
// ==========================
|
|
function getSolcoverJS(config){
|
|
return `module.exports = ${JSON.stringify(config, null, ' ')}`
|
|
}
|
|
|
|
|
|
// ==========================
|
|
// Migration Generators
|
|
// ==========================
|
|
function deploySingle(contractName){
|
|
return `
|
|
const A = artifacts.require("${contractName}");
|
|
module.exports = function(deployer) { deployer.deploy(A) };
|
|
`;
|
|
}
|
|
|
|
function deployDouble(contractNames){
|
|
return `
|
|
var A = artifacts.require("${contractNames[0]}");
|
|
var B = artifacts.require("${contractNames[1]}");
|
|
module.exports = function(deployer) {
|
|
deployer.deploy(A);
|
|
deployer.link(A, B);
|
|
deployer.deploy(B);
|
|
};
|
|
`;
|
|
}
|
|
|
|
// ==========================
|
|
// Project Installers
|
|
// ==========================
|
|
/**
|
|
* Installs mock truffle/buidler project at ./temp with a single contract
|
|
* and test specified by the params.
|
|
* @param {String} contract <contractName.sol> located in /test/sources/cli/
|
|
* @param {[type]} test <testName.js> located in /test/cli/
|
|
*/
|
|
function install(
|
|
contract,
|
|
test,
|
|
solcoverConfig,
|
|
devPlatformConfig,
|
|
noMigrations
|
|
) {
|
|
if(solcoverConfig) solcoverJS = getSolcoverJS(solcoverConfig);
|
|
|
|
const migration = deploySingle(contract);
|
|
|
|
// Scaffold
|
|
shell.mkdir(temp);
|
|
shell.cp('-Rf', templatePath, temp);
|
|
|
|
// Contract
|
|
shell.cp(`${sourcesPath}${contract}.sol`, `${temp}/contracts/${contract}.sol`);
|
|
|
|
// Migration
|
|
if (!noMigrations) fs.writeFileSync(migrationPath, migration);
|
|
|
|
// Test
|
|
shell.cp(`${testPath}${test}`, `${temp}/test/${test}`);
|
|
|
|
// Configs
|
|
fs.writeFileSync(`${temp}/${truffleConfigName}`, getTruffleConfigJS(devPlatformConfig));
|
|
fs.writeFileSync(`${temp}/${buidlerConfigName}`, getBuidlerConfigJS(devPlatformConfig));
|
|
fs.writeFileSync(`${temp}/${hardhatConfigName}`, getHardhatConfigJS(devPlatformConfig));
|
|
if(solcoverConfig) fs.writeFileSync(configPath, solcoverJS);
|
|
|
|
decacheConfigs();
|
|
};
|
|
|
|
/**
|
|
* Installs mock truffle/buidler project with two contracts (for inheritance, libraries, etc)
|
|
*/
|
|
function installDouble(contracts, test, config, skipMigration) {
|
|
const configjs = getSolcoverJS(config);
|
|
const migration = deployDouble(contracts);
|
|
|
|
// Scaffold
|
|
shell.mkdir(temp);
|
|
shell.cp('-Rf', templatePath, temp);
|
|
|
|
// Contracts
|
|
contracts.forEach(item => {
|
|
(item.includes('.'))
|
|
? shell.cp(`${sourcesPath}${item}`, `${temp}/contracts/${item}`)
|
|
: shell.cp(`${sourcesPath}${item}.sol`, `${temp}/contracts/${item}.sol`);
|
|
});
|
|
|
|
// Migration
|
|
if (!skipMigration){
|
|
fs.writeFileSync(migrationPath, migration)
|
|
}
|
|
|
|
// Test
|
|
shell.cp(`${testPath}${test}`, `${temp}/test/${test}`);
|
|
|
|
// Configs
|
|
fs.writeFileSync(`${temp}/${truffleConfigName}`, getTruffleConfigJS());
|
|
fs.writeFileSync(`${temp}/${buidlerConfigName}`, getBuidlerConfigJS());
|
|
fs.writeFileSync(`${temp}/${hardhatConfigName}`, getHardhatConfigJS());
|
|
fs.writeFileSync(configPath, configjs);
|
|
|
|
decacheConfigs();
|
|
};
|
|
|
|
/**
|
|
* Installs full truffle/buidler project
|
|
*/
|
|
function installFullProject(name, config) {
|
|
shell.mkdir(temp);
|
|
shell.cp('-Rf', `${projectPath}${name}/{.,}*`, temp);
|
|
|
|
if (config){
|
|
const configjs = getSolcoverJS(config);
|
|
fs.writeFileSync(`${temp}/.solcover.js`, configjs);
|
|
}
|
|
|
|
decacheConfigs();
|
|
}
|
|
|
|
// ==========================
|
|
// Logging
|
|
// ==========================
|
|
const loggerOutput = {
|
|
val: ''
|
|
};
|
|
|
|
const testLogger = {
|
|
log: (val) => {
|
|
if (val !== undefined) loggerOutput.val += val;
|
|
if (!process.env.SILENT && val !== undefined)
|
|
console.log(val)
|
|
}
|
|
}
|
|
|
|
module.exports = {
|
|
pathToTemp: pathToTemp,
|
|
testLogger: testLogger,
|
|
loggerOutput: loggerOutput,
|
|
getDefaultTruffleConfig: getDefaultTruffleConfig,
|
|
getDefaultBuidlerConfig: getDefaultBuidlerConfig,
|
|
getDefaultHardhatConfig: getDefaultHardhatConfig,
|
|
install: install,
|
|
installDouble: installDouble,
|
|
installFullProject: installFullProject,
|
|
clean: clean,
|
|
pathToContract: pathToContract,
|
|
getOutput: getOutput,
|
|
buidlerSetupEnv: buidlerSetupEnv,
|
|
buidlerTearDownEnv: buidlerTearDownEnv,
|
|
hardhatSetupEnv: hardhatSetupEnv,
|
|
hardhatTearDownEnv: hardhatTearDownEnv
|
|
}
|
|
|
|
|