This page contains a brief tutorial on how to carry out validation work for the R synapseClient and they python synapseclient.

Synapse client development workflow

The aim of the Synapse client development process is to ensure that all issues tracked have been validated in a test environment before clients are release to the broader community of users. In JIRA, this means that all issues must be 'Closed' by a validator before release of a client.

The 'Validation' that is being discussing in this wiki is the step moving from 'Resolved' to 'Closed' in the above simplified workflow. For users tasked to validate an issue, the following mechanisms are in place for access to the development versions of the clients – where validation work is to be done.

R synapseClient

Test versions of the R synapseClient will be released each Friday to the 'staging' partition of the Sage LRAN. In order to access the version of the client to do validation work for a particular week, install the synapseClient for the 'staging' partition:

source("http://depot.sagebase.org/CRAN.R")
pkgInstall("synapseClient", "staging")

Once the package is installed, load the library and check to make sure the version of the synapseClient matches the "fix version" of the issue(s) to be validated.

require(synapseClient)
packageVersion("synapseClient")

When the issue is validated to be complete, come back to the JIRA page for the issue and mark it as 'Closed'.

Python synapseclient

Test versions of the python synapseclient will be tagged each Friday corresponding with the fix version in JIRA. In order to access the version of the client to do validation work for a particular week, install the synapseclient by accessing the code from GitHub:

git clone git://github.com/Sage-Bionetworks/synapsePythonClient.git
cd synapsePythonClient
git checkout v0.5.1.dev2
python setup.py develop 

If the clone already exists locally, instead fetch updates from GitHub (if Sage-Bionetworks repo was cloned as origin, then below code will be appropriate):

cd synapsePythonClient
git fetch origin
git checkout v0.5.1.dev2
python setup.py develop

When the issue is validated to be complete, come back to the JIRA page for the issue and mark it as 'Closed'.