The KBase SDK is a set of tools for developing KBase Apps that can be dynamically registered and run on the KBase platform. Apps are grouped into modules that include all code, dependencies, specification files, and documentation needed to define and run Apps in the KBase Narrative interface.
Documentation in this readme is for developing the SDK codebase itself. If you want to develop an app using the SDK, please visit the documentation website linked above.
Running the tests and VM
You can run the tests using a Vagrant image with
make test-vagrant. You can enter the Vagrant VM for debugging by running
To run the tests directly, run
make test in the project's root directory. Python tests should currently pass. Java (and Perl) tests are currently in progress.
To completely rebuild your vagrant image, run
vagrant halt and
vagrant up within this repo's root directory.
Notes and references
The codebase currently uses Java 8 and is incompatible with Java 9. Details about this incompatibility can be found here: https://blog.codefx.org/java/jsr-305-java-9/. Specifically, the "@Generated" annotation is problematic.
Rebuilding the VM
To rebuild the VM for running tests, follow the steps in this document: doc/test_dependencies.md