Add API test harness for Linux & OSX #4366
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ApiTestConfig works like :common Config, but specific to this subproject. BisqAppConfig is an enumeration specifying Bisq desktop and daemon options for running seednode, arbnode, bob & alices nodes in regtest / full-dao mode.
* apitest.properties - config file for customizing ApiTestConfig options * logback.xml - logging config file, will override logback files found in classpath * bitcoin.conf - bitcoin-core regtest config file, overwritten during startup with correct path to blocknofity * blocknotify - bitcoin-core blocknotify config file
Finding the pid of background linux/java processes has been difficult to do from java, so a bash script is provided to simplify the task.
The apitest.linux package is for running random bash commands, running 'bitcoind -regtest', running random 'bitcoin-cli -regtest' commands, and spinning up Bisq apps such as seednode, arbnode, and bob & alice nodes. All but random bash and bitcoin-cli commands are run in the background. The bitcoin-cli response processing is crude; a more sophiticated bitcoin-core rpc interface is not in the scope of this PR.
The driver class uses an ExecutorService to submit Callable tasks for starting bitcoind and Bisq nodes as Linux background processes. By default, ApiTestMain starts background processes to support regtest/dao testing, runs a few bitcoin-cli commands, then shuts down all background processes before exiting. (Actual API test suites have not been implemented yet.) ApiTestConfig options can be used to skip tests and/or leave background processes running indefinitely.
This gradle file is 'applied' by the main build file.
Usage:
Run a full clean, build, download dao-setup.zip,
and install the zip files contents in directory
apitest/build/resources/main:
./gradlew clean build :apitest:installDaoSetup
Download (if necessary) the dao-setup.zip file
and install its contents in directory
apitest/build/resources/main (no build).
./gradlew :apitest:installDaoSetup
Unnecessary use of fully qualified name 'System.exit' due to existing static import 'java.lang.System.exit'. (line 100) Avoid throwing raw exception types. (lines 295, 302)
Avoid throwing raw exception types. Combine nested if statements.
Avoid throwing null pointer exceptions.
|
Does this require adding new jar deps? |
The |
dmos62
suggested changes
Jul 10, 2020
There is no need for this as any JavaFX based :desktop instances will be started as background linux processes.
The `berkeleyDbLibPath` option now defaults to an empty string. If not set to a berkeley lib path on the command line or the apitest.properties file, this option is ignored, and 'bitcoind' will be started without first exporting the berkeley db library path. In other words: If the bitcoind binary is dynamically linked to berkeley db libs, export the configured berkeley-db lib path before starting 'bitcoind'. If statically linked, the berkeley db lib path will not be exported. Also fixed exception msgs to show missing config file's absolute path.
SetupTask submissions for Bisq background apps seednode, arbnode, etc., would not always complete due to a blocking stderr stream handler thread.join() call. This change makes waiting on a bash process err stream optional.
ApiTestMain will run all defined tests, but we also want to run individual test suites and test cases, and they will need to run the setup tasks as well.
Added :proto to the :apitest classpath for access to grpc service stubs (to be) used in method (unit) tests. Added new GrpcStubs class to expose the grpc service stubs to method and scenario tests. The larger goal of :apitest is end to end testing, where :cli's console output is checked for correctness. This change partially addresses two other important use cases: * "method" testing -- an analog to unit testing * "scenario" testing -- an analog to narrow functional testing For example, tests in the apitest.method package will directly call grpc services, and asserts will be made on the return values instead of console output. Tests in the apitest.scenario package will check correctness for broader use cases, such as funding a wallet, encrypting then unlocking a wallet for a specific time frame, or checking error messages from the server when a "getbalance" call is made after an "unlockwallet" timeout has expired. The broader end to end tests will not use grpc stubs.
Avoid throwing raw exception types. Document empty method body.
Codacy wants comments inside an empty method.
Add super class for all test types (method, scenario, end-to-end), and an class & method level annotation for skipping tests.
These are method test cases for gRPC methods that have already been well tested by :cli/test.sh
|
Closing/reopening PR to force travis build after pricenode unit test failure . |
|
Closing/reopening PR again to force codacy check after @ripcurlx made some codacy config changes. |
Closing/reopening PR does not force codacy check. |
A new commit was needed to force a codacy check after changes were made to codacy rules.
This commit is for forcing a codacy check. The previous change to an .md doc did not force a codacy check.
Follow codacy rule against empty blocks.
|
This PR should be merged before PR 4417. |
|
@ghubstan I contacted Codacy on this issue. As the configuration problem should be solved (I've even deactivated it for testing), but it sill doesn't green light this PR. |
I pushed a change to shorten some too-long lines in one class, and codacy passed it. But I don't know if the problems are fixed yet, since codacy analyzed only the one changed class(?) I may push a small change to the next PR , based off this one, to see what codacy does with it. By the way, the failed Travis CI JDK12 test failed to install JDK 12, so I won't close/re-open this PR to force another Travis build. I don't want to risk losing the Codacy Review PASS ;) |
ghubstan
referenced
this pull request
in ghubstan/bisq
Aug 24, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new
:apitestsubproject to Bisq with the following goals::desktoptesting in regtest/full-dao modeIt requires the installation of bitcoin-core v0.19 or v0.20 binaries in the $PATH, or the path to them defined in the subproject's config file
src/main/resources/apitest.properties:The
:apitestbuild downloads and installs dao-setup files forbitcoind, bob & alice datadirs inapitest/build/resources/main, and test case@BeforeAllmethods startbitcoind,seednode,arbitrationnode (:desktopor:daemon), plus bob & alice nodes (:desktopor:daemon) as Linux background processes. Currently, the only testing mode supported is regtest / full-dao mode, without Tor.To run a full clean build, and install dao setup files:
To install or re-install dao setup files:
To run API
@Testcases:A gradle Test Summary containing any initialization errors and test failures can be found in
This test harness works on a 2014 Mac mini with a Dual-Core i5 and 8 Gb RAM.
[EDITED 27-July-2020]