Add BitBox02 Simulator #741
Conversation
test/test_device.py
Outdated
| @@ -130,11 +129,12 @@ def create(*args, **kwargs): | |||
| return c | |||
|
|
|||
| class DeviceTestCase(unittest.TestCase): | |||
| def __init__(self, bitcoind, emulator=None, interface='library', methodName='runTest'): | |||
| def __init__(self, bitcoind, emulator=None, interface='library', methodName='runTest', supports_legacy=True): | |||
There was a problem hiding this comment.
supports_legacy should be a property of the emulator, not an argument to the test case. See supports_taproot.
There was a problem hiding this comment.
Okay, we can use this convention. I'll updating that shortly, but then I will also add the relevant field to the other emulators.
test/test_device.py
Outdated
| keypool_desc = self.do_command(self.dev_args + ["getkeypool", "--account", "10", "--addr-type", "legacy", "0", "100"]) | ||
| addr_type = "legacy" if self.supports_legacy else "sh_wit" | ||
| keypool_desc = self.do_command(self.dev_args + ["getkeypool", "--account", "10", "--addr-type", addr_type, "0", "100"]) |
There was a problem hiding this comment.
It should be fine to just change the address type to sh_wit always instead of using legacy for the other devices.
There was a problem hiding this comment.
Okay, changed the types to sh_wit
test/setup_environment.sh
Outdated
| docker pull shiftcrypto/firmware_v2:latest | ||
| # The safe.directory config is so that git commands work. even though the repo folder mounted in | ||
| # Docker is owned by root, which can be different from the owner on the host. | ||
| docker run -i --rm --volume ./:/bb02 shiftcrypto/firmware_v2 bash -c "git config --global --add safe.directory /bb02 && cd /bb02 && make -j simulator" |
There was a problem hiding this comment.
This script needs to work when run inside a docker container as that is how the tests are suggested to be run locally. IIRC Docker within docker doesn't really work, so I don't think this will.
asi345
force-pushed
the
bitbox02_simulator
branch
from
609db6a
to
5e94111
Compare
Signed-off-by: asi345 <[email protected]>
asi345
force-pushed
the
bitbox02_simulator
branch
from
5e94111
to
cacfcc6
Compare
|
Okay, we also came up with a solution for docker in docker problem for bitbox02 simulator. |
asi345
force-pushed
the
bitbox02_simulator
branch
from
cacfcc6
to
7a1d0c1
Compare
test/README.md
Outdated
| Pull the BitBox02 firmware Docker image: | ||
|
|
||
| ``` | ||
| docker pull shiftcrypto/firmware_v2:latest |
There was a problem hiding this comment.
Replace with
cd bitbox02-firmware
make dockerpull
(remove the cd below then)
test/setup_environment.sh
Outdated
| fi | ||
|
|
||
| # Build the simulator. This is cached, but it is also fast | ||
| docker pull shiftcrypto/firmware_v2:latest |
There was a problem hiding this comment.
use $(cat .containerversion) instead of latest here too
Signed-off-by: asi345 <[email protected]>
asi345
force-pushed
the
bitbox02_simulator
branch
from
7a1d0c1
to
b8b679a
Compare
|
@achow101 please approve the workflow and take another look at the changes, would be really nice to have this merged soon. Thanks! |
|
Could you rebase so that CI runs the tests with the simulator? |
| In order to build the BitBox02 simulator, the following packages will need to be installed: | ||
|
|
||
| ``` | ||
| apt install docker.io |
There was a problem hiding this comment.
Isn't there a way to build it without docker?
There was a problem hiding this comment.
Not really, this is how we build and release the BB02 firmware. Replicating the Docker environment outside of it is bound to lead to tons of overhead in maintenance and CI breaks.
podman instead of docker would also work though.
There was a problem hiding this comment.
Ok, anyway, I could build and run it. No problem.
| parser.add_argument('--interface', help='Which interface to send commands over', choices=['library', 'cli', 'bindist'], default='library') | ||
| args = parser.parse_args() | ||
|
|
||
| sys.exit(not bitbox02_test_suite(args.simulator, None, None)) |
There was a problem hiding this comment.
I had some problems with this test. It seems it should pass bitcoind and interface in bitbox02_test_suite instead of None, no?
| docker pull shiftcrypto/firmware_v2:$CONTAINER_VERSION | ||
| # The safe.directory config is so that git commands work. even though the repo folder mounted in | ||
| # Docker is owned by root, which can be different from the owner on the host. | ||
| docker run -i --rm --volume ./:/bb02 shiftcrypto/firmware_v2:$CONTAINER_VERSION bash -c "git config --global --add safe.directory /bb02 && cd /bb02 && make -j simulator" |
There was a problem hiding this comment.
Got this error running setup_environment.sh:
+ docker run -i --rm --volume ./:/bb02 shiftcrypto/firmware_v2:42 bash -c 'git config --global --add safe.directory /bb02 && cd /bb02 && make -j simulator'
docker: Error response from daemon: create ./: "./" includes invalid characters for a local volume name, only "[a-zA-Z0-9][a-zA-Z0-9_.-]" are allowed. If you intended to pass a host directory, use absolute path.
I think you could use "$(pwd):/bb02" instead of ./:/bb02.
Recently, a simulator for BitBox02 was implemented. Therefore, we also wanted to add this to HWI repository for automated tests and ease of reference in the future.