remix-project/remix-resolve/tests/test.js

const rr = require('../src/index.js')
const assert = require('assert')
const fs = require('fs')
const solc = require('solc')

describe('testRunner', function () {
  describe('#combineSource', function() {
    describe('test example_1 [local imports]]', function () {
      let filename = '../remix-resolve/tests/example_1/greeter.sol'
      let results = {}

      before(function (done) {
        const content = fs.readFileSync(filename).toString()
        var sources = []
        sources['greeter.sol'] = { 'content': content }
        rr.combineSource('../remix-resolve/tests/example_1/', sources)
          .then(sources => {
            results = sources
            done()
          })
          .catch(e => {
            throw e
          })
      })

      it('should 1 passing test', function () {
        assert.equal(Object.keys(results).length, 2)
      })

      it('should returns 2 contracts with specified content', function () {
        assert.deepEqual(results, { 'mortal.sol':{ content: 'pragma solidity ^0.5.0;\n\ncontract Mortal {\n    /* Define variable owner of the type address */\n    address payable owner;\n\n    /* This function is executed at initialization and sets the owner of the contract */\n    function mortal() public { owner = msg.sender; }\n\n    /* Function to recover the funds on the contract */\n    function kill() public { if (msg.sender == owner) selfdestruct(owner); }\n}\n' },
        'greeter.sol': { content: 'pragma solidity ^0.5.0;\nimport \"./mortal.sol\";\n\ncontract Greeter is Mortal {\n    /* Define variable greeting of the type string */\n    string greeting;\n\n    /* This runs when the contract is executed */\n    constructor(string memory _greeting) public {\n        greeting = _greeting;\n    }\n\n    /* Main function */\n    function greet() public view returns (string memory) {\n        return greeting;\n    }\n}\n' }})
      })
    })

    describe('test example_2 [github imports]', function () {
      let filename = '../remix-resolve/tests/example_2/github_import.sol'
      let results = {}

      before(function (done) {
        const content = fs.readFileSync(filename).toString()
        var sources = []
        sources['github_import.sol'] = { 'content': content }
        rr.combineSource('../remix-resolve/tests/example_2/', sources)
          .then(sources => {
            results = sources
            done()
          })
          .catch(e => {
            throw e
          })
      })

      it('should 1 passing test', function () {
        assert.equal(Object.keys(results).length, 2)
      })

      it('should returns 2 contracts with specified content', function () {
        assert.deepEqual(results, { 'https://github.com/OpenZeppelin/zeppelin-solidity/contracts/math/SafeMath.sol': { content: 'pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks that revert on error\n */\nlibrary SafeMath {\n    /**\n    * @dev Multiplies two numbers, reverts on overflow.\n    */\n    function mul(uint256 a, uint256 b) internal pure returns (uint256) {\n        \/\/ Gas optimization: this is cheaper than requiring \'a\' not being zero, but the\n        \/\/ benefit is lost if \'b\' is also tested.\n        \/\/ See: https://github.com/OpenZeppelin/openzeppelin-solidity/pull/522\n        if (a == 0) {\n            return 0;\n        }\n\n        uint256 c = a * b;\n        require(c / a == b);\n\n        return c;\n    }\n\n    /**\n    * @dev Integer division of two numbers truncating the quotient, reverts on division by zero.\n    */\n    function div(uint256 a, uint256 b) internal pure returns (uint256) {\n        \/\/ Solidity only automatically asserts when dividing by 0\n        require(b > 0);\n        uint256 c = a / b;\n        \/\/ assert(a == b * c + a % b); \/\/ There is no case in which this doesn\'t hold\n\n        return c;\n    }\n\n    \/**\n    * @dev Subtracts two numbers, reverts on overflow (i.e. if subtrahend is greater than minuend).\n    *\/\n    function sub(uint256 a, uint256 b) internal pure returns (uint256) {\n        require(b <= a);\n        uint256 c = a - b;\n\n        return c;\n    }\n\n    /**\n    * @dev Adds two numbers, reverts on overflow.\n    */\n    function add(uint256 a, uint256 b) internal pure returns (uint256) {\n        uint256 c = a + b;\n        require(c >= a);\n\n        return c;\n    }\n\n    \/**\n    * @dev Divides two numbers and returns the remainder (unsigned integer modulo),\n    * reverts when dividing by zero.\n    *\/\n    function mod(uint256 a, uint256 b) internal pure returns (uint256) {\n        require(b != 0);\n        return a % b;\n    }\n}\n' },
        'github_import.sol': { content: 'pragma solidity ^0.5.0;\nimport \'https://github.com/OpenZeppelin/zeppelin-solidity/contracts/math/SafeMath.sol\';\n\ncontract SimpleMath {\n    using SafeMath for uint;\n}\n' }})
      })
    })
  })

  // Test successful compile after combineSource
  describe('test example_1 for successful compile', function() {
    let filename = '../remix-resolve/tests/example_1/greeter.sol'
    let results = {}

    before(function (done) {
      const content = fs.readFileSync(filename).toString()
      let sources = []
      sources['greeter.sol'] = { 'content': content }
      rr.combineSource('../remix-resolve/tests/example_1/', sources)
        .then(sources => {
          const outputSelection = {
              // Enable the metadata and bytecode outputs of every single contract.
              '*': {
                  '': ['legacyAST'],
                  '*': ['abi', 'evm.bytecode.object', 'devdoc', 'userdoc', 'evm.gasEstimates']
              }
          }
          const settings = {
              optimizer: { enabled: true, runs: 500 },
              evmVersion: 'byzantium',
              outputSelection
          }
          const input = { language: 'Solidity', sources, settings }
          results = solc.compile(JSON.stringify(input))
          done()
        })
        .catch(e => {
          throw e
        })
    })
    it('should match compiled reult', function () {
      assert.deepEqual(results, `{"contracts":{"greeter.sol":{"Greeter":{"abi":[{"constant":false,"inputs":[],"name":"kill","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[],"name":"greet","outputs":[{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[],"name":"mortal","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"inputs":[{"name":"_greeting","type":"string"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"}],"devdoc":{"methods":{}},"evm":{"bytecode":{"linkReferences":{},"object":"608060405234801561001057600080fd5b5060405161036d38038061036d8339810180604052602081101561003357600080fd5b81019080805164010000000081111561004b57600080fd5b8201602081018481111561005e57600080fd5b815164010000000081118282018710171561007857600080fd5b505080519093506100929250600191506020840190610099565b5050610134565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106100da57805160ff1916838001178555610107565b82800160010185558215610107579182015b828111156101075782518255916020019190600101906100ec565b50610113929150610117565b5090565b61013191905b80821115610113576000815560010161011d565b90565b61022a806101436000396000f3fe608060405260043610610050577c0100000000000000000000000000000000000000000000000000000000600035046341c0e1b58114610055578063cfae32171461006c578063f1eae25c146100f6575b600080fd5b34801561006157600080fd5b5061006a61010b565b005b34801561007857600080fd5b50610081610148565b6040805160208082528351818301528351919283929083019185019080838360005b838110156100bb5781810151838201526020016100a3565b50505050905090810190601f1680156100e85780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561010257600080fd5b5061006a6101dd565b60005473ffffffffffffffffffffffffffffffffffffffff163314156101465760005473ffffffffffffffffffffffffffffffffffffffff16ff5b565b60018054604080516020601f600260001961010087891615020190951694909404938401819004810282018101909252828152606093909290918301828280156101d35780601f106101a8576101008083540402835291602001916101d3565b820191906000526020600020905b8154815290600101906020018083116101b657829003601f168201915b5050505050905090565b6000805473ffffffffffffffffffffffffffffffffffffffff19163317905556fea165627a7a723058204facb10e9947102cf2229b615bcb6ea700a6f361f5d538c2d88968e5d683a7240029","opcodes":"PUSH1 0x80 PUSH1 0x40 MSTORE CALLVALUE DUP1 ISZERO PUSH2 0x10 JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST POP PUSH1 0x40 MLOAD PUSH2 0x36D CODESIZE SUB DUP1 PUSH2 0x36D DUP4 CODECOPY DUP2 ADD DUP1 PUSH1 0x40 MSTORE PUSH1 0x20 DUP2 LT ISZERO PUSH2 0x33 JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST DUP2 ADD SWAP1 DUP1 DUP1 MLOAD PUSH5 0x100000000 DUP2 GT ISZERO PUSH2 0x4B JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST DUP3 ADD PUSH1 0x20 DUP2 ADD DUP5 DUP2 GT ISZERO PUSH2 0x5E JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST DUP2 MLOAD PUSH5 0x100000000 DUP2 GT DUP3 DUP3 ADD DUP8 LT OR ISZERO PUSH2 0x78 JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST POP POP DUP1 MLOAD SWAP1 SWAP4 POP PUSH2 0x92 SWAP3 POP PUSH1 0x1 SWAP2 POP PUSH1 0x20 DUP5 ADD SWAP1 PUSH2 0x99 JUMP JUMPDEST POP POP PUSH2 0x134 JUMP JUMPDEST DUP3 DUP1 SLOAD PUSH1 0x1 DUP2 PUSH1 0x1 AND ISZERO PUSH2 0x100 MUL SUB AND PUSH1 0x2 SWAP1 DIV SWAP1 PUSH1 0x0 MSTORE PUSH1 0x20 PUSH1 0x0 KECCAK256 SWAP1 PUSH1 0x1F ADD PUSH1 0x20 SWAP1 DIV DUP2 ADD SWAP3 DUP3 PUSH1 0x1F LT PUSH2 0xDA JUMPI DUP1 MLOAD PUSH1 0xFF NOT AND DUP4 DUP1 ADD OR DUP6 SSTORE PUSH2 0x107 JUMP JUMPDEST DUP3 DUP1 ADD PUSH1 0x1 ADD DUP6 SSTORE DUP3 ISZERO PUSH2 0x107 JUMPI SWAP2 DUP3 ADD JUMPDEST DUP3 DUP2 GT ISZERO PUSH2 0x107 JUMPI DUP3 MLOAD DUP3 SSTORE SWAP2 PUSH1 0x20 ADD SWAP2 SWAP1 PUSH1 0x1 ADD SWAP1 PUSH2 0xEC JUMP JUMPDEST POP PUSH2 0x113 SWAP3 SWAP2 POP PUSH2 0x117 JUMP JUMPDEST POP SWAP1 JUMP JUMPDEST PUSH2 0x131 SWAP2 SWAP1 JUMPDEST DUP1 DUP3 GT ISZERO PUSH2 0x113 JUMPI PUSH1 0x0 DUP2 SSTORE PUSH1 0x1 ADD PUSH2 0x11D JUMP JUMPDEST SWAP1 JUMP JUMPDEST PUSH2 0x22A DUP1 PUSH2 0x143 PUSH1 0x0 CODECOPY PUSH1 0x0 RETURN INVALID PUSH1 0x80 PUSH1 0x40 MSTO
    })
  })

  // Test handleImportCb
  describe('test github imports compilation with callback', function() {
    let filename = '../remix-resolve/tests/example_1/greeter.sol'
    let sources = {}, results = {}

    before(function (done) {
      const outputSelection = {
          // Enable the metadata and bytecode outputs of every single contract.
          '*': {
              '': ['ast', 'legacyAST'],
              '*': ['abi', 'evm.bytecode.object', 'devdoc', 'userdoc', 'evm.gasEstimates']
          }
      }
      const settings = {
          optimizer: { enabled: true, runs: 500 },
          evmVersion: 'byzantium',
          outputSelection
      }

      const content = fs.readFileSync(filename).toString()
      var sources = []
      sources['greeter.sol'] = { 'content': content }
      rr.combineSource('../remix-resolve/tests/example_1/', sources)
        .then(combinedSources => {
          const input = { language: 'Solidity', sources: combinedSources, settings }
          const findImportsSync = function (path) {
            return rr.getFile(path, combinedSources)
          }
          try {
            results = solc.compile(JSON.stringify(input), findImportsSync)
            done()
          } catch (e) {
            throw e
          }
        })
        .catch(e => {
          throw e
        })
    })
    it('should match compiled result', function () {
      const msg = `{"contracts":{"greeter.sol":{"Greeter":{"abi":[{"constant":false,"inputs":[],"name":"kill","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[],"name":"greet","outputs":[{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[],"name":"mortal","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"inputs":[{"name":"_greeting","type":"string"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"}],"devdoc":{"methods":{}},"evm":{"bytecode":{"linkReferences":{},"object":"608060405234801561001057600080fd5b5060405161036d38038061036d8339810180604052602081101561003357600080fd5b81019080805164010000000081111561004b57600080fd5b8201602081018481111561005e57600080fd5b815164010000000081118282018710171561007857600080fd5b505080519093506100929250600191506020840190610099565b5050610134565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106100da57805160ff1916838001178555610107565b82800160010185558215610107579182015b828111156101075782518255916020019190600101906100ec565b50610113929150610117565b5090565b61013191905b80821115610113576000815560010161011d565b90565b61022a806101436000396000f3fe608060405260043610610050577c0100000000000000000000000000000000000000000000000000000000600035046341c0e1b58114610055578063cfae32171461006c578063f1eae25c146100f6575b600080fd5b34801561006157600080fd5b5061006a61010b565b005b34801561007857600080fd5b50610081610148565b6040805160208082528351818301528351919283929083019185019080838360005b838110156100bb5781810151838201526020016100a3565b50505050905090810190601f1680156100e85780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561010257600080fd5b5061006a6101dd565b60005473ffffffffffffffffffffffffffffffffffffffff163314156101465760005473ffffffffffffffffffffffffffffffffffffffff16ff5b565b60018054604080516020601f600260001961010087891615020190951694909404938401819004810282018101909252828152606093909290918301828280156101d35780601f106101a8576101008083540402835291602001916101d3565b820191906000526020600020905b8154815290600101906020018083116101b657829003601f168201915b5050505050905090565b6000805473ffffffffffffffffffffffffffffffffffffffff19163317905556fea165627a7a723058204facb10e9947102cf2229b615bcb6ea700a6f361f5d538c2d88968e5d683a7240029","opcodes":"PUSH1 0x80 PUSH1 0x40 MSTORE CALLVALUE DUP1 ISZERO PUSH2 0x10 JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST POP PUSH1 0x40 MLOAD PUSH2 0x36D CODESIZE SUB DUP1 PUSH2 0x36D DUP4 CODECOPY DUP2 ADD DUP1 PUSH1 0x40 MSTORE PUSH1 0x20 DUP2 LT ISZERO PUSH2 0x33 JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST DUP2 ADD SWAP1 DUP1 DUP1 MLOAD PUSH5 0x100000000 DUP2 GT ISZERO PUSH2 0x4B JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST DUP3 ADD PUSH1 0x20 DUP2 ADD DUP5 DUP2 GT ISZERO PUSH2 0x5E JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST DUP2 MLOAD PUSH5 0x100000000 DUP2 GT DUP3 DUP3 ADD DUP8 LT OR ISZERO PUSH2 0x78 JUMPI PUSH1 0x0 DUP1 REVERT JUMPDEST POP POP DUP1 MLOAD SWAP1 SWAP4 POP PUSH2 0x92 SWAP3 POP PUSH1 0x1 SWAP2 POP PUSH1 0x20 DUP5 ADD SWAP1 PUSH2 0x99 JUMP JUMPDEST POP POP PUSH2 0x134 JUMP JUMPDEST DUP3 DUP1 SLOAD PUSH1 0x1 DUP2 PUSH1 0x1 AND ISZERO PUSH2 0x100 MUL SUB AND PUSH1 0x2 SWAP1 DIV SWAP1 PUSH1 0x0 MSTORE PUSH1 0x20 PUSH1 0x0 KECCAK256 SWAP1 PUSH1 0x1F ADD PUSH1 0x20 SWAP1 DIV DUP2 ADD SWAP3 DUP3 PUSH1 0x1F LT PUSH2 0xDA JUMPI DUP1 MLOAD PUSH1 0xFF NOT AND DUP4 DUP1 ADD OR DUP6 SSTORE PUSH2 0x107 JUMP JUMPDEST DUP3 DUP1 ADD PUSH1 0x1 ADD DUP6 SSTORE DUP3 ISZERO PUSH2 0x107 JUMPI SWAP2 DUP3 ADD JUMPDEST DUP3 DUP2 GT ISZERO PUSH2 0x107 JUMPI DUP3 MLOAD DUP3 SSTORE SWAP2 PUSH1 0x20 ADD SWAP2 SWAP1 PUSH1 0x1 ADD SWAP1 PUSH2 0xEC JUMP JUMPDEST POP PUSH2 0x113 SWAP3 SWAP2 POP PUSH2 0x117 JUMP JUMPDEST POP SWAP1 JUMP JUMPDEST PUSH2 0x131 SWAP2 SWAP1 JUMPDEST DUP1 DUP3 GT ISZERO PUSH2 0x113 JUMPI PUSH1 0x0 DUP2 SSTORE PUSH1 0x1 ADD PUSH2 0x11D JUMP JUMPDEST SWAP1 JUMP JUMPDEST PUSH2 0x22A DUP1 PUSH2 0x143 PUSH1 0x0 CODECOPY PUSH1 0x0 RETURN INVALID PUSH1 0x80 PUSH1 0x40 MSTORE PUSH1 0x4 C
      assert.deepEqual(results, msg)
    })
  })
})