BYOC @develop

lib/commands/compile.js

@@ -1,19 +1,94 @@
+var format = JSON.stringify;
+
 var command = {
   command: 'compile',
   description: 'Compile contract source files',
   builder: {
     all: {
       type: "boolean",
       default: false
+    },
+    list: {
+      type: "string",
+    },
+    help: {
+      type: "boolean",
+      default: "false"
     }
   },
+
   run: function (options, done) {
     var Config = require("truffle-config");
     var Contracts = require("truffle-workflow-compile");
+    var CompilerProvider = require("truffle-compile").CompilerProvider;
+    var provider = new CompilerProvider();
 
     var config = Config.detect(options);
-    Contracts.compile(config, done);
-  }
+
+    (config.list !== undefined)
+      ? command.listVersions(provider, config, done)
+      : Contracts.compile(config, done);
+  },
+
+  listVersions: function(provider, options, done){
+    const log = options.logger.log;
+    options.list = (options.list.length) ? options.list : "releases";
+
+    // Help
+    if (options.list && options.help){
+      log(command.help);
+      return done();
+    }
+
+    // Docker tags
+    if (options.list === 'docker'){
+      return provider
+        .getDockerTags()
+        .then(tags => {
+          tags.push('See more at: hub.docker.com/r/ethereum/solc/tags/')
+          log(format(tags));
+          done();
+        })
+        .catch(done);
+    }
+
+    // Solcjs releases
+    provider
+      .getReleases()
+      .then(releases => {
+        const shortener = options.all ? null : command.shortener;
+        const list = format(releases[options.list], shortener, ' ');
+        log(list);
+        done();
+      })
+      .catch(done);
+  },
+
+  shortener: function(key, val){
+    const defaultLength = 10;
+
+    if (Array.isArray(val) && val.length > defaultLength){
+      const length = val.length;
+      const remaining = length - defaultLength;
+      const more = '.. and ' + remaining + ' more. Use `--all` to see full list.';
+      val.length = defaultLength;
+      val.push(more);
+    }
+
+    return val;
+  },
+
+  help: "\n" +
+        "See available solc versions. (Default: solcjs stable releases)\n\n" +
+
+        "USAGE:\n" +
+        "   --list [option] [--all]\n\n" +
+
+        "OPTIONS:\n" +
+        " `docker`         recently published docker tags\n" +
+        " `releases`       solcjs stable releases\n" +
+        " `prereleases`    solcjs nightly builds\n" +
+        " `latestRelease`  solcjs latest\n\n",
 }
 
 module.exports = command;

lib/testing/soliditytest.js

@@ -104,6 +104,7 @@ var SolidityTest = {
 
       compile.with_dependencies(runner.config.with({
         paths: [
+          "truffle/Assert.sol",
           "truffle/DeployedAddresses.sol",
           path.join(__dirname, "SafeSend.sol")
         ],

package.json

@@ -76,6 +76,7 @@
   ],
   "devDependencies": {
     "ipfsd-ctl": "^0.21.0",
+    "memorystream": "^0.3.1",
     "truffle-blockchain-utils": "^0.0.4"
   }
 }

test/compile.js

@@ -3,14 +3,19 @@ var Box = require("truffle-box");
 var Contracts = require("truffle-workflow-compile");
 var Artifactor = require("truffle-artifactor");
 var Resolver = require("truffle-resolver");
+var MemoryStream = require('memorystream');
+var command = require('../lib/commands/compile');
 var path = require("path");
 var fs = require("fs");
 
 describe("compile", function() {
   var config;
+  var output = '';
+  var memStream;
 
   before("Create a sandbox", function(done) {
     this.timeout(10000);
+
     Box.sandbox(function(err, result) {
       if (err) return done(err);
       config = result;
@@ -25,10 +30,13 @@ describe("compile", function() {
         }
       };
       config.network = "default";
+      config.logger = {log: (val) => val && memStream.write(val)};
       done();
     });
   });
 
+  afterEach("Clear MemoryStream", () => output = '');
+
   it('compiles all initial contracts', function(done) {
     this.timeout(10000);
 
@@ -57,10 +65,10 @@ describe("compile", function() {
     });
   });
 
-  it('compiles updated contract and descendents', function(done) {
+  it('compiles updated contract and its ancestors', function(done) {
     this.timeout(10000);
 
-    var file_to_update = path.resolve(path.join(config.contracts_directory, "MetaCoin.sol"));
+    var file_to_update = path.resolve(path.join(config.contracts_directory, "ConvertLib.sol"));
     var stat = fs.statSync(file_to_update);
 
     // Update the modification time to simulate an edit.
@@ -82,36 +90,104 @@ describe("compile", function() {
     });
   });
 
-  it('compiles updated contract and its ancestors', function(done) {
-    this.timeout(10000);
+  it("compiling shouldn't create any network artifacts", function() {
+    var contract = config.resolver.require("MetaCoin.sol");
+    assert.equal(Object.keys(contract.networks).length, 0, "Expected the contract to be managing zero networks");
+  });
 
-    var file_to_update = path.resolve(path.join(config.contracts_directory, "ConvertLib.sol"));
-    var stat = fs.statSync(file_to_update);
+  describe('solc listing options', function(){
 
-    // Update the modification time to simulate an edit.
-    var newTime = new Date().getTime();
-    fs.utimesSync(file_to_update, newTime, newTime);
+    beforeEach(() => {
+      memStream = new MemoryStream();
+      memStream.on('data', function(data){ output += data.toString()});
+    })
 
-    Contracts.compile(config.with({
-      all: false,
-      quiet: true
-    }), function(err, contracts) {
-      if (err) return done(err);
+    it("prints a truncated list of solcjs versions", function(done){
+      this.timeout(5000);
 
-      assert.equal(Object.keys(contracts).length, 2, "Expected MetaCoin and ConvertLib to be compiled");
+      const options = {
+        list: ""
+      };
 
-      // reset time
-      fs.utimesSync(file_to_update, stat.atime, stat.mtime);
+      command.run(config.with(options), (err, result) => {
+        if(err) return done(err);
 
-      done();
+        memStream.on('end', function() {
+          const arr = JSON.parse(output);
+          assert(arr.length === 11);
+          done();
+        });
+
+        memStream.end('');
+      })
+    })
+
+    it("prints a list of docker tags", function(done){
+      this.timeout(5000);
+
+      const options = {
+        list: "docker"
+      };
+
+      command.run(config.with(options), (err, result) => {
+        if(err) return done(err);
+
+        memStream.on('end', function() {
+          const arr = JSON.parse(output);
+          assert(arr.length === 11);
+          assert(typeof arr[0] === 'string');
+          done();
+        });
+
+        memStream.end('');
+      })
+    })
+
+    it("prints a full list of releases when --all is set", function(done){
+      this.timeout(5000);
+
+      const options = {
+        list: "releases",
+        all: true
+      };
+
+      command.run(config.with(options), (err, result) => {
+        if(err) return done(err);
+
+        memStream.on('end', function() {
+          const arr = JSON.parse(output);
+          assert(arr.length > 11);
+          assert(typeof arr[0] === 'string');
+          done();
+        });
+
+        memStream.end('');
+      })
     });
-  });
 
-  it("compiling shouldn't create any network artifacts", function() {
-    var contract = config.resolver.require("MetaCoin.sol");
-    assert.equal(Object.keys(contract.networks).length, 0, "Expected the contract to be managing zero networks");
+    it("prints a help when list and help are set", function(done){
+      this.timeout(5000);
+
+      const options = {
+        list: "releases",
+        help: true
+      };
+
+      command.run(config.with(options), (err, result) => {
+        if(err) return done(err);
+
+        memStream.on('end', function() {
+          assert(output.includes('USAGE'));
+          done();
+        });
+
+        memStream.end('');
+      })
+    })
   });
 
+
+
   // TODO: Kept this as a comment because I'm confused if it applies.
   // Since the binary and abi are updated with every compile, and they're not within
   // the networks object anymore, it may not matter when that specific network changed.

test/ethpm.js

@@ -153,6 +153,8 @@ describe('EthPM integration', function() {
         assert.isNotNull(contracts["transferable"]);
 
         fs.readdir(config.contracts_build_directory, function(err, files) {
+          if (err) return done(err);
+
           var found = [false, false];
           var search = ["owned", "transferable"];
 

test/npm.js

@@ -15,7 +15,7 @@ describe('NPM integration', function() {
   var parentContractSource = "pragma solidity ^0.4.2; import 'fake_source/contracts/Module.sol'; contract Parent {}";
 
   before("Create a sandbox", function(done) {
-    this.timeout(10000);
+    this.timeout(15000);
     Box.sandbox(function(err, result) {
       if (err) return done(err);
       config = result;

test/profiler.js

@@ -23,12 +23,13 @@ describe('profiler', function() {
 
   it('profiles example project successfully', function(done) {
     Profiler.required_sources(config.with({
-      paths: ["./MetaCoin.sol"],
+      paths: ["./ConvertLib.sol"],
       base_path: config.contracts_directory
-    }), function(err, result) {
+    }), function(err, allSources, compilationTargets) {
       if (err) return done(err);
 
-      assert.equal(Object.keys(result).length, 2);
+      assert.equal(Object.keys(allSources).length, 3);
+      assert.equal(compilationTargets.length, 2);
       done();
     });
   });