Build and test new Apps for the KBase platorm
Java Python Perl HTML Shell JavaScript Other
Latest commit 295b61b Jun 14, 2018
Permalink
Failed to load latest commit information.
.vscode Patched up for input object Feb 7, 2017
doc Update copy on codebase_anatomy.md May 30, 2018
javacc Add deprecated annotation to *defs parsed structures Jun 1, 2016
lib Prep for merge into master Aug 29, 2017
sdkbase Fix tests & python build Jan 24, 2018
src Change name of the base image that is built/used Feb 15, 2018
submodules More fixes in relation to auth2 Mar 21, 2017
submodules_hacks Fix SDK tests to run with no external dependencies May 2, 2016
test_scripts Update Java reqs, deprecate R Jan 24, 2018
.classpath Update class-path and jars submodule Feb 21, 2017
.gitignore Merge branch 'develop' into docs-point-to-gh-pages May 18, 2018
.gitmodules Deleting typecomp submodule Mar 21, 2017
.project Binary lib is updated Oct 7, 2016
.pydevproject Forgot pydev eclipse config Oct 7, 2016
.travis.yml Fixes per PR-268 Aug 24, 2017
DEPENDENCIES Initial commit. Apr 13, 2015
Dockerfile Added option to create shell script, update docs, and reduced size fu… Jan 23, 2017
JAR_DEPS Rolling back one change in Makefile. Feb 18, 2017
JAR_DEPS_BIN Updating binary lib Mar 23, 2017
KBaseJobService.spec Initial commit. Apr 13, 2015
LICENSE.md added readme and license files Apr 13, 2015
Makefile Create a `test-vagrant` target for the Makefile that runs tests in th… May 7, 2018
README.md Clean up README.md May 22, 2018
RELEASE_NOTES.txt Update Java reqs, deprecate R Jan 24, 2018
Vagrantfile Add the Vagrantfile for building the test VM May 7, 2018
build.xml Bug fix in client installer related to case of external spec-file URL. Oct 12, 2016
entrypoint - Minor doc fixes Mar 23, 2018
tox.ini Updated tox.ini Oct 20, 2016

README.md

alt text KBase SDK

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.

SDK user documentation can be found here

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 vagrant ssh.

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

Java Versions

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