This repository has been archived by the owner on Feb 23, 2018. It is now read-only.
forked from irods-contrib/metalnx-web
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#14 clean up test properties and add readme for unit test setup
- Loading branch information
1 parent
ec8973f
commit d50549e
Showing
1 changed file
with
115 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| # Developer notes | ||
|
|
||
| ## Testing setup | ||
| Metalnx has been updated to use the same testing.properties setup and settings.xml from jargon | ||
| tests. See https://github.com/DICE-UNC/jargon/wiki/Setting-up-unit-tests for some orientation. | ||
|
|
||
| Those jargon notes specify how to configure a target iRODS instance as a test platform. It is recommended that testing | ||
| not be done on a shared server and certainly on a production server! | ||
|
|
||
| ### settings | ||
|
|
||
| Unit tests rely on two properties files: | ||
|
|
||
| * testing.properties - generated by pom.xml, identical to the settings and properties utilized by the Jargon unit tests. NB that | ||
| there is still work to do to fully integrate the jargon unit testing facilities into the metanlx tests, so right now it's mostly | ||
| surfacing those properties in the existing spring config. | ||
|
|
||
| * test.metalnx.properties - generated by pom.xml. This is the test analogue to the normal /etc/irods-ext/metalnx.properties | ||
| used in production deployments | ||
|
|
||
| For Junit tests, the /test/resources spring config files should pick both of these up by classpath: references | ||
|
|
||
| ### maven setup | ||
|
|
||
| Add Jargon profile information to the settings.xml in maven per the above Jargon notes, something like this. Note that this | ||
| refers to a private VM running on VirtualBox on the developer's machine, and this form of test setup is highly recommended! | ||
|
|
||
| ```xml | ||
| <profile> | ||
| <id>irods421.irodslocal</id> | ||
| <properties> | ||
| <jargon.test.data.directory>/Users/conwaymc/temp/irodsscratch/</jargon.test.data.directory> | ||
| <jargon.test.irods.admin>rods</jargon.test.irods.admin> | ||
| <jargon.test.irods.admin.password>rods</jargon.test.irods.admin.password> | ||
| <jargon.test.irods.user>test1</jargon.test.irods.user> | ||
| <jargon.test.irods.password>test</jargon.test.irods.password> | ||
| <jargon.test.irods.resource>test1-resc</jargon.test.irods.resource> | ||
| <jargon.test.irods.user2>test2</jargon.test.irods.user2> | ||
| <jargon.test.irods.password2>test</jargon.test.irods.password2> | ||
| <jargon.test.irods.resource2>test1-resc2</jargon.test.irods.resource2> | ||
| <jargon.test.irods.resource3>test1-resc3</jargon.test.irods.resource3> | ||
| <jargon.test.irods.user3>test3</jargon.test.irods.user3> | ||
| <jargon.test.irods.password3>test</jargon.test.irods.password3> | ||
| <jargon.test.kerberos.user /> | ||
| <jargon.test.irods.host>irods421.irodslocal</jargon.test.irods.host> | ||
| <jargon.test.irods.port>1247</jargon.test.irods.port> | ||
| <jargon.test.irods.zone>zone1</jargon.test.irods.zone> | ||
| <jargon.test.resource.group>testResourceGroup</jargon.test.resource.group> | ||
| <jargon.test.user.group>jargonTestUg</jargon.test.user.group> | ||
| <jargon.test.irods.userDN>test1DN</jargon.test.irods.userDN> | ||
| <jargon.test.irods.scratch.subdir>jargon-scratch</jargon.test.irods.scratch.subdir> | ||
| <jargon.test.option.exercise.remoteexecstream>true</jargon.test.option.exercise.remoteexecstream> | ||
| <jargon.test.option.exercise.ticket>true</jargon.test.option.exercise.ticket> | ||
| <jargon.test.option.exercise.audit>false</jargon.test.option.exercise.audit> | ||
| <jargon.test.option.exercise.workflow>false</jargon.test.option.exercise.workflow> | ||
| <jargon.test.option.exercise.filesystem.mount>false</jargon.test.option.exercise.filesystem.mount> | ||
| <test.option.mount.basedir>/home/mconway/temp/basedir</test.option.mount.basedir> | ||
| <jargon.test.pam.user>pam</jargon.test.pam.user> | ||
| <jargon.test.pam.password>pam</jargon.test.pam.password> | ||
| <test.option.pam>false</test.option.pam> | ||
| <test.option.ssl.configured>false</test.option.ssl.configured> | ||
| <test.option.distributed.resources>false</test.option.distributed.resources> | ||
| <test.option.registration>false</test.option.registration> | ||
| <test.option.federated.zone>false</test.option.federated.zone> | ||
| <test.option.kerberos>false</test.option.kerberos> | ||
| <test.option.strictACL>false</test.option.strictACL> | ||
| <test.rest.port>8888</test.rest.port> | ||
| <jargon.test.federated.irods.admin>rods</jargon.test.federated.irods.admin> | ||
| <jargon.test.federated.irods.admin.password>test</jargon.test.federated.irods.admin.password> | ||
| <jargon.test.federated.irods.user>test1</jargon.test.federated.irods.user> | ||
| <jargon.test.federated.irods.password>test</jargon.test.federated.irods.password> | ||
| <jargon.test.federated.irods.resource>test1-resc</jargon.test.federated.irods.resource> | ||
| <jargon.test.federated.irods.host>fedzone2</jargon.test.federated.irods.host> | ||
| <jargon.test.federated.irods.port>1247</jargon.test.federated.irods.port> | ||
| <jargon.test.federated.irods.zone>fedzone2</jargon.test.federated.irods.zone> | ||
| <test.option.python>true</test.option.python> | ||
| </properties> | ||
| </profile> | ||
|
|
||
|
|
||
| ``` | ||
|
|
||
| In addition, an additional profile for Metalnx is required, like this... | ||
|
|
||
|
|
||
| ```xml | ||
|
|
||
| <profile> | ||
| <id>metalnx-local</id> | ||
| <properties> | ||
| <metalnx.auth.scheme>STANDARD</metalnx.auth.scheme> | ||
| <metalnx.ssl.policy>CS_NEG_REFUSE</metalnx.ssl.policy> | ||
| <metalnx.packing.streams>true</metalnx.packing.streams> | ||
| <metalnx.compute.checksum>true</metalnx.compute.checksum> | ||
| <metalnx.jdbc.driver>org.postgresql.Driver</metalnx.jdbc.driver> | ||
| <metalnx.jdbc.url>jdbc:postgresql://localhost:5432/metalnx</metalnx.jdbc.url> | ||
| <metalnx.jdbc.user>metalnx</metalnx.jdbc.user> | ||
| <metalnx.jdbc.password>metalnx</metalnx.jdbc.password> | ||
| <metalnx.jdbc.dialect>org.hibernate.dialect.PostgreSQLDialect</metalnx.jdbc.dialect> | ||
| </properties> | ||
| </profile> | ||
|
|
||
|
|
||
| ``` | ||
|
|
||
| Here it's pointing to a Postgres database, pretty soon we'll show an example with a local | ||
| database like Derby, that's probably a better plan. | ||
|
|
||
| ### Generating test properties and running tests | ||
|
|
||
| A mvn install will cause these properties files to be generated. Once the irods server | ||
| and database are initially installed and configured, and the properties are all set | ||
| correctly in settings.xml (be sure to activate the appropriate profiles in maven!) You should | ||
| get a clean build running the tests, and once maven has run to get the properties, running | ||
| unit tests in eclipse, etc should also work fine. |