filippsen
commented
6 years ago Initial test reference (vanilla version)
This reference aims to: a. Demonstrate what a working test example using Web3 would look like; b. Analyze what would be the required dependencies for running it; c. Analyze what would be the inputs necessary to enable testing arbitrary contracts.
This leads to extensive and verbose code (read: explicit and raw). The testing code could be further compressed into a simpler API, focused on providing shortcuts to the most commonly used operations.
The example test reference is based on the HelloWorld.sol contract from Hello World project template.
Dependencies
- ABI
- Mocha
- Tx
- Web3
Inputs
- contract ABI (or contract source code and access to the compiler)
- contract binary (or contract source code and access to the compiler)
- valid account address (or access to existing wallet)
- corresponding account private key (or access to existing wallet)
Example
Note: some details were suppressed for readability.
describe('User test action: manually check contract data', function (done) {
var contractInstance;
beforeEach(function (done) {
const contractBin = "0x6060...";
const contractABI = instance.abi;
web3.eth.getTransactionCount(account_address, function(error, result) {
[...]
const tx = new Tx[...]
web3.eth.sendRawTransaction("0x"+tx.serialize().toString("hex"),
[...]
getTransactionReceipt(currentContractTransactionHash, function(err, res) {
[...]
var contract = web3.eth.contract(contractABI);
contractInstance = contract.at(res.contractAddress);
done();
});
});
});
});
it('matches message data', function (done) {
var expectedValue = "Hello World!";
contractInstance.message(function(error, result) {
if(error) {
console.error(error);
done(error);
} else {
if(result !== expectedValue) {
done(new Error(result));
} else {
done();
}
}
});
});
it('update message data', function (done) {
[...]
web3.eth.getTransactionCount(account_address, function(error, result) {
if(error) {
done(new Error("Could not get nonce for address " + account_address));
} else {
account_nonce=result;
var data = ABI.ABI.simpleEncode("update(string)", "Super Hello World!");
[...]
const tx = new Tx[...]
web3.eth.sendRawTransaction("0x"+tx.serialize().toString("hex"),
function(error, result) {
if(error) {
console.error(error);
done(error);
} else {
contractInstance.message(function(error, result) {
var expectedValue = "Super Hello World!";
if(error) {
console.error(error);
done(error);
} else {
if(result !== expectedValue) {
done(new Error(result));
} else {
[...]
done();
}
}
});
}
}
);
}
});
});
});
Summary
Add support for providing tests to be run against currently selected project.
Motivation
Additional context
Tasks
Test Runner
To enable inspecting all the tests written for the currently open project.
[x] New tests directory
In progress inrefactoringbranch and https://github.com/SuperblocksHQ/superblocks-lab/issues/166master(version 1.1.0) intofeature/testing-GUI. New branch created:feature/master-testing[x] New Tests button
[x] New Tests panel
[x] GUI
[x] A panel, not a window
[x] Contains "X" close button
[x] Contains a "control bar"
[x] Contains the tests list
[x] Contains a "Test Summary" bar
[x] Contains a "Console Output"
[x] Complete interaction with any test file from
/tests/[x] Solidify low-level test run calls (Security ? Correctness ? Speed ?)
[ ] Fix all that is marked as
TODO[ ] Resolve all
FIXMEoccurrences[x] Properly format the new code added during the early stages (legacy)