tests: add and follow solium rules

Author: come-maiz

.soliumrc.json

@@ -0,0 +1,15 @@
+{
+  "extends": "solium:all",
+  "plugins": ["security"],
+  "rules": {
+    "quotes": ["error", "double"],
+    "no-empty-blocks": "off",
+    "indentation": ["error", 2],
+    "max-len": ["error", 79],
+    "no-constant": ["error"],
+    "security/enforce-explicit-visibility": ["error"],
+    "security/no-block-members": ["warning"],
+    "security/no-inline-assembly": ["warning"],
+    "arg-overflow": ["off"]
+  }
+}

.travis.yml

@@ -1,18 +1,31 @@
 language: node_js
 node_js:
 - '8'
+
 cache:
   directories:
   - node_modules
-env:
-  - 
-  - SOLIDITY_COVERAGE=true
-matrix:
+
+jobs:
+  # XXX fast_finish doesn't work with stages yet. See
+  # https://github.com/travis-ci/travis-ci/issues/8425
+  # --elopio - 20180531
   fast_finish: true
   allow_failures:
     - env: SOLIDITY_COVERAGE=true
-script:
-  - npm test
+  include:
+    # Run the unit test suite three times in parallel.
+    # The first one gets results faster and is the only one required to pass.
+    # The second one generates the coverage report.
+    - stage: unit
+      script: npm test
+    - stage: unit
+      script: npm run test
+      env: SOLIDITY_COVERAGE=true
+    # solidity and javascript style tests.
+    - stage: static
+      script: npm run lint:sol
+
 notifications:
   slack:
     rooms:

contracts/application/AppDirectory.sol

@@ -4,6 +4,7 @@ import "./versioning/ImplementationProvider.sol";
 import "./versioning/ImplementationDirectory.sol";
 import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 
+
 /**
  * @title AppDirectory
  * @dev Implementation directory with a standard library as a fallback provider.
@@ -38,10 +39,14 @@ contract AppDirectory is ImplementationDirectory {
    * @return Address where the contract is implemented, or 0 if it is not
    * found.
    */
-  function getImplementation(string contractName) public view returns (address) {
+  function getImplementation(string contractName)
+    public view returns (address)
+  {
     address implementation = super.getImplementation(contractName);
-    if(implementation != address(0)) return implementation;
-    if(stdlib != address(0)) return stdlib.getImplementation(contractName);
+    if (implementation != address(0))
+      return implementation;
+    if (stdlib != address(0))
+      return stdlib.getImplementation(contractName);
     return address(0);
   }
 

contracts/application/BaseApp.sol

@@ -5,6 +5,7 @@ import "../upgradeability/AdminUpgradeabilityProxy.sol";
 import "../upgradeability/UpgradeabilityProxyFactory.sol";
 import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 
+
 /**
  * @title BaseApp
  * @dev Abstract base contract for upgradeable applications.
@@ -23,18 +24,14 @@ contract BaseApp is Ownable {
     factory = _factory;
   }
 
-  /**
-   * @dev Abstract function to return the implementation provider.
-   * @return The implementation provider.
-   */
-  function getProvider() internal view returns (ImplementationProvider);
-
   /**
    * @dev Returns the implementation address for a given contract name, provided by the `ImplementationProvider`.
    * @param contractName Name of the contract.
    * @return Address where the contract is implemented.
    */
-  function getImplementation(string contractName) public view returns (address) {
+  function getImplementation(string contractName)
+    public view returns (address)
+  {
     return getProvider().getImplementation(contractName);
   }
 
@@ -43,7 +40,10 @@ contract BaseApp is Ownable {
    * @param contractName Name of the contract.
    * @return Address of the new proxy.
    */
-  function create(string contractName) public returns (AdminUpgradeabilityProxy) {
+  function create(string contractName)
+    public
+    returns (AdminUpgradeabilityProxy)
+  {
     address implementation = getImplementation(contractName);
     return factory.createProxy(this, implementation);
   }
@@ -58,17 +58,31 @@ contract BaseApp is Ownable {
    * https://solidity.readthedocs.io/en/develop/abi-spec.html#function-selector-and-argument-encoding.
    * @return Address of the new proxy.
    */
-   function createAndCall(string contractName, bytes data) payable public returns (AdminUpgradeabilityProxy) {
+  function createAndCall(
+    string contractName,
+    bytes data
+  )
+    payable
+    public
+    returns (AdminUpgradeabilityProxy)
+  {
     address implementation = getImplementation(contractName);
-    return factory.createProxyAndCall.value(msg.value)(this, implementation, data);
+    return factory.createProxyAndCall.value(
+      msg.value)(this, implementation, data);
   }
 
   /**
    * @dev Upgrades a proxy to the newest implementation of a contract.
    * @param proxy Proxy to be upgraded.
    * @param contractName Name of the contract.
    */
-  function upgrade(AdminUpgradeabilityProxy proxy, string contractName) public onlyOwner {
+  function upgrade(
+    AdminUpgradeabilityProxy proxy,
+    string contractName
+  )
+    public
+    onlyOwner
+  {
     address implementation = getImplementation(contractName);
     proxy.upgradeTo(implementation);
   }
@@ -83,7 +97,15 @@ contract BaseApp is Ownable {
    * called, as described in
    * https://solidity.readthedocs.io/en/develop/abi-spec.html#function-selector-and-argument-encoding.
    */
-  function upgradeAndCall(AdminUpgradeabilityProxy proxy, string contractName, bytes data) payable public onlyOwner {
+  function upgradeAndCall(
+    AdminUpgradeabilityProxy proxy,
+    string contractName,
+    bytes data
+  )
+    payable
+    public
+    onlyOwner
+  {
     address implementation = getImplementation(contractName);
     proxy.upgradeToAndCall.value(msg.value)(implementation, data);
   }
@@ -93,7 +115,9 @@ contract BaseApp is Ownable {
    * This is needed because only the proxy admin can query it.
    * @return The address of the current implementation of the proxy.
    */
-  function getProxyImplementation(AdminUpgradeabilityProxy proxy) public view returns (address) {
+  function getProxyImplementation(AdminUpgradeabilityProxy proxy)
+    public view returns (address)
+  {
     return proxy.implementation();
   }
 
@@ -102,7 +126,16 @@ contract BaseApp is Ownable {
    * Only the admin can query it.
    * @return The address of the current admin of the proxy.
    */
-  function getProxyAdmin(AdminUpgradeabilityProxy proxy) public view returns (address) {
+  function getProxyAdmin(AdminUpgradeabilityProxy proxy)
+    public view returns (address)
+  {
     return proxy.admin();
   }
+
+  /**
+   * @dev Abstract function to return the implementation provider.
+   * @return The implementation provider.
+   */
+  function getProvider() internal view returns (ImplementationProvider);
+
 }

contracts/application/PackagedApp.sol

@@ -4,6 +4,7 @@ import "./BaseApp.sol";
 import "./versioning/Package.sol";
 import "../upgradeability/UpgradeabilityProxyFactory.sol";
 
+
 /**
  * @title PackagedApp
  * @dev App for an upgradeable project that can use different versions.
@@ -21,7 +22,11 @@ contract PackagedApp is BaseApp {
    * @param _version Initial version of the app.
    * @param _factory Proxy factory.
    */
-  function PackagedApp(Package _package, string _version, UpgradeabilityProxyFactory _factory)
+  function PackagedApp(
+    Package _package,
+    string _version,
+    UpgradeabilityProxyFactory _factory
+  )
     BaseApp(_factory)
     public
   {

contracts/application/UnversionedApp.sol

@@ -4,6 +4,7 @@ import "./BaseApp.sol";
 import "./versioning/ImplementationProvider.sol";
 import "../upgradeability/UpgradeabilityProxyFactory.sol";
 
+
 /**
  * @title UnversionedApp
  * @dev Basic implementation of an upgradable app with no versioning.
@@ -19,21 +20,16 @@ contract UnversionedApp is BaseApp {
    * @param _provider Implementation provider.
    * @param _factory Proxy factory.
    */
-  function UnversionedApp(ImplementationProvider _provider, UpgradeabilityProxyFactory _factory)
+  function UnversionedApp(
+    ImplementationProvider _provider,
+    UpgradeabilityProxyFactory _factory
+  )
     BaseApp(_factory)
     public
   {
     setProvider(_provider);
   }
 
-  /**
-   * @dev Returns the provider used by the app.
-   * @return The provider.
-   */
-  function getProvider() internal view returns (ImplementationProvider) {
-    return provider;
-  }
-
   /**
    * @dev Sets a new implementation provider.
    * @param _provider New implementation provider
@@ -42,4 +38,13 @@ contract UnversionedApp is BaseApp {
     require(address(_provider) != address(0));
     provider = _provider;
   }
+
+  /**
+   * @dev Returns the provider used by the app.
+   * @return The provider.
+   */
+  function getProvider() internal view returns (ImplementationProvider) {
+    return provider;
+  }
+
 }

contracts/application/versioning/FreezableImplementationDirectory.sol

@@ -2,11 +2,12 @@ pragma solidity ^0.4.21;
 
 import "./ImplementationDirectory.sol";
 
+
 /**
  * @title FreezableImplementationDirectory
  * @dev Implementation directory which can be made irreversibly immutable by the owner.
  */
- contract FreezableImplementationDirectory is ImplementationDirectory {
+contract FreezableImplementationDirectory is ImplementationDirectory {
   /// @dev Mutability state of the directory.
   bool public frozen;
 
@@ -32,7 +33,12 @@ import "./ImplementationDirectory.sol";
    * @param contractName Name of the contract.
    * @param implementation Address where the contract is implemented.
    */
-  function setImplementation(string contractName, address implementation) public whenNotFrozen {
+  function setImplementation(
+    string contractName,
+    address implementation
+  )
+    public whenNotFrozen
+  {
     super.setImplementation(contractName, implementation);
   }
 }

contracts/application/versioning/ImplementationDirectory.sol

@@ -2,7 +2,8 @@ pragma solidity ^0.4.21;
 
 import "./ImplementationProvider.sol";
 import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
-import 'openzeppelin-solidity/contracts/AddressUtils.sol';
+import "openzeppelin-solidity/contracts/AddressUtils.sol";
+
 
 /**
  * @title ImplementationDirectory
@@ -24,7 +25,9 @@ contract ImplementationDirectory is ImplementationProvider, Ownable {
    * @param contractName Name of the contract.
    * @return Address of the implementation.
    */
-  function getImplementation(string contractName) public view returns (address) {
+  function getImplementation(string contractName)
+    public view returns (address)
+  {
     return implementations[contractName];
   }
 
@@ -33,7 +36,13 @@ contract ImplementationDirectory is ImplementationProvider, Ownable {
    * @param contractName Name of the contract.
    * @param implementation Address of the implementation.
    */
-  function setImplementation(string contractName, address implementation) public onlyOwner {
+  function setImplementation(
+    string contractName,
+    address implementation
+  )
+    public
+    onlyOwner
+  {
     require(AddressUtils.isContract(implementation));
     implementations[contractName] = implementation;
     emit ImplementationChanged(contractName, implementation);

contracts/application/versioning/ImplementationProvider.sol

@@ -10,5 +10,6 @@ interface ImplementationProvider {
    * @param contractName Name of the contract.
    * @return Implementation address of the contract.
    */
-  function getImplementation(string contractName) public view returns (address);
+  function getImplementation(string contractName)
+    public view returns (address);
 }

contracts/application/versioning/Package.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.4.21;
 import "./ImplementationProvider.sol";
 import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 
+
 /**
  * @title Package
  * @dev Collection of contracts grouped into versions.
@@ -27,7 +28,9 @@ contract Package is Ownable {
    * @param version Name of the version.
    * @return The implementation provider of the version.
    */
-  function getVersion(string version) public view returns (ImplementationProvider) {
+  function getVersion(string version)
+    public view returns (ImplementationProvider)
+  {
     ImplementationProvider provider = versions[version];
     return provider;
   }
@@ -37,7 +40,13 @@ contract Package is Ownable {
    * @param version Name of the version.
    * @param provider ImplementationProvider associated with the version.
    */
-  function addVersion(string version, ImplementationProvider provider) public onlyOwner {
+  function addVersion(
+    string version,
+    ImplementationProvider provider
+  )
+    public
+    onlyOwner
+  {
     require(!hasVersion(version));
     versions[version] = provider;
     emit VersionAdded(version, provider);
@@ -58,7 +67,9 @@ contract Package is Ownable {
    * @param contractName Name of the contract.
    * @return Address where the contract is implemented.
    */
-  function getImplementation(string version, string contractName) public view returns (address) {
+  function getImplementation(string version, string contractName)
+    public view returns (address)
+  {
     ImplementationProvider provider = getVersion(version);
     return provider.getImplementation(contractName);
   }

contracts/application/versioning/Release.sol

@@ -2,6 +2,7 @@ pragma solidity ^0.4.21;
 
 import "./FreezableImplementationDirectory.sol";
 
+
 /**
  * @title Release
  * @dev This contract represents a particular standard library version from a developer.