org.alfresco.bm.common.mongo

Class MongoTestDAO

java.lang.Object

org.alfresco.bm.common.mongo.MongoTestDAO

All Implemented Interfaces:

LifecycleListener

public class MongoTestDAO
extends Object
implements LifecycleListener

MongoDB persistence of test metadata

Since:

2.0

Author:

Derek Hulley, Frank Becker

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_TEST_DEFS
static String	COLLECTION_TEST_DRIVERS
static String	COLLECTION_TEST_PROPS
static String	COLLECTION_TEST_RUNS
static String	COLLECTION_TESTS

Constructor Summary

Constructors

Constructor and Description
MongoTestDAO(com.mongodb.DB db) Construct the DAO using the Mongo DB directly

Method Summary

Modifier and Type	Method and Description
void	addTestRunDriver(org.bson.types.ObjectId runObjId, String driverId) Register a driver with a test run
boolean	copyTest(String test, String release, Integer schema, String copyOfTest, int copyOfVersion) Create a new test by copying an existing test.
boolean	copyTestRun(String test, String run, String copyOfRun, int copyOfVersion) Create a new test run by copying an existing test run.
long	countDrivers(String release, Integer schema, boolean active) Count registered drivers
boolean	createTest(String test, String description, String release, Integer schema) Create a new test for the precise release and schema
boolean	createTestRun(String test, String run, String description) Create a new test run
com.mongodb.DBObject	decryptPropertyValue(com.mongodb.DBObject dbObject, String propName) Decrypt property if encrypted
boolean	deleteTest(String test) Delete an existing test
boolean	deleteTestRun(org.bson.types.ObjectId runObjId) Delete an existing test run
boolean	deleteTestRun(String test, String run) Delete an existing test run
com.mongodb.DBObject	encryptPropertyValue(com.mongodb.DBObject dbObject, String propName) Encrypts property DB object
com.mongodb.DBObject	exportTest(String testName) Exports the test with properties as JSON
com.mongodb.DBObject	exportTestRun(String testName, String runName) Exports a test run with encrypted password properties by test and run name.
com.mongodb.DB	getDb()
com.mongodb.DBCursor	getDrivers(String release, Integer schema, boolean active) Get registered test drivers
Set<String>	getMaskedProperyNames(String testName) Fetch masked property names (passwords) by test name.
Set<String>	getMaskedProperyNames(String release, Integer schema) Fetch masked property names (passwords) by release and version name.
com.mongodb.DBObject	getProperty(String test, String run, String propertyName) Retrieve the effective property for a given test, test run and property name.
String	getPropValueAsString(com.mongodb.DBObject dbPropertyObj) Returns the value or default of the property as string
com.mongodb.DBObject	getTest(org.bson.types.ObjectId testObjId, boolean includeProperties) Retrieve the data for given test
com.mongodb.DBObject	getTest(String test, boolean includeProperties) Retrieve the data for given test
com.mongodb.DBObject	getTestDef(String release, Integer schema) Retrieve a specific (and full) test definition
com.mongodb.DBCursor	getTestDefs(boolean active, int skip, int count)
Map<String,com.mongodb.DBObject>	getTestPropertiesMap(org.bson.types.ObjectId testObjId, String testName) Returns the map with "final" test run properties of the test run.
com.mongodb.DBObject	getTestRun(org.bson.types.ObjectId runObjId, boolean includeProperties) Retrieve the data for given test run
com.mongodb.DBObject	getTestRun(String test, String run, boolean includeProperties) Retrieve the data for given test run
List<String>	getTestRunNames(String test) Get the test run names associated with a given test
Map<String,com.mongodb.DBObject>	getTestRunPropertiesMap(org.bson.types.ObjectId testObjId, org.bson.types.ObjectId runObjId, String testName, String testRunName) Returns the map with "final" test run properties of the test run.
com.mongodb.DBCursor	getTestRuns(String test, int skip, int count, TestRunState... testRunStates)
com.mongodb.DBCursor	getTests(String release, Integer schema, int skip, int count) Get a list of all defined tests
com.mongodb.DBObject	importTest(String testName, com.mongodb.DBObject importObj) Imports the properties of a test from JSON.
com.mongodb.DBObject	importTestRun(String testName, String runName, com.mongodb.DBObject importObj)
boolean	isMaskedProperty(com.mongodb.DBObject property) Checks if the DBObject contains a field FIELD_MASK and returns true if set
void	lockProperties(org.bson.types.ObjectId testObjId, org.bson.types.ObjectId runObjId) Record a final set of locked properties for a test run.
void	refreshDriver(String id, long expiryTime) Refresh the expiry time of a driver
String	registerDriver(String release, Integer schema, String ipAddress, String hostname, String contextPath, Set<String> capabilities) Register a test driver
void	removeTestRunDriver(org.bson.types.ObjectId runObjId, String driverId) Derigister a driver from a test run
boolean	setPropertyOverride(String test, String run, String propertyName, int version, String value) Override a specific test property value.
void	start() Initialize indexes
void	stop()
void	unregisterDriver(String id) Unregister a test driver
boolean	updateTest(String name, int version, String newName, String newDescription, String newRelease, Integer newSchema) Update an existing test to use new test details
boolean	updateTestRun(String test, String run, int version, String newName, String newDescription) Update an existing test run with new details
boolean	updateTestRunState(org.bson.types.ObjectId runId, int version, TestRunState testRunState, Long scheduled, Long started, Long stopped, Long completed, Long duration, Double progress, Long resultsSuccess, Long resultsFail) Update the run state of a test run.
boolean	writeTestDef(String release, Integer schema, String description, List<TestProperty> testProperties) Write all the test application's property definitions against the release and schema number

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COLLECTION_TEST_DEFS

public static final String COLLECTION_TEST_DEFS

See Also:

Constant Field Values

COLLECTION_TEST_DRIVERS

public static final String COLLECTION_TEST_DRIVERS

See Also:

Constant Field Values

COLLECTION_TESTS

public static final String COLLECTION_TESTS

See Also:

Constant Field Values

COLLECTION_TEST_PROPS

public static final String COLLECTION_TEST_PROPS

See Also:

Constant Field Values

COLLECTION_TEST_RUNS

public static final String COLLECTION_TEST_RUNS

See Also:

Constant Field Values

Constructor Detail

MongoTestDAO

public MongoTestDAO(com.mongodb.DB db)

Construct the DAO using the Mongo DB directly

Method Detail

getDb

public com.mongodb.DB getDb()

Returns:

the database being used

start

public void start()

Initialize indexes

Specified by:

start in interface LifecycleListener

stop

public void stop()

Specified by:

stop in interface LifecycleListener

registerDriver

public String registerDriver(String release,
                             Integer schema,
                             String ipAddress,
                             String hostname,
                             String contextPath,
                             Set<String> capabilities)

Register a test driver

Parameters:

release - the software release version

schema - the schema number

ipAddress - the IP address of the machine the application is running on

contextPath - the application context path (or similar) for information

capabilities - the features supported by the driver

Returns:

a unique registration key

refreshDriver

public void refreshDriver(String id,
                          long expiryTime)

Refresh the expiry time of a driver

Parameters:

id - the driver id

expiryTime - the new expiry time

unregisterDriver

public void unregisterDriver(String id)

Unregister a test driver

Parameters:

id - the ID of the registration

getDrivers

public com.mongodb.DBCursor getDrivers(String release,
                                       Integer schema,
                                       boolean active)

Get registered test drivers

Parameters:

release - the release name of the test or null for all releases

schema - the schema number of the driver or null for all schemas

countDrivers

public long countDrivers(String release,
                         Integer schema,
                         boolean active)

Count registered drivers

Parameters:

release - the release name of the test or null for all releases

schema - the schema number of the driver or null for all schemas

liveOnly - true to retrieve only live instances

Returns:

a count of the number of drivers matching the criteria

writeTestDef

public boolean writeTestDef(String release,
                            Integer schema,
                            String description,
                            List<TestProperty> testProperties)

Write all the test application's property definitions against the release and schema number

Parameters:

release - the test release name

schema - the property schema

description - a description of the test definition

testProperties - the property definitions

Returns:

true if the properties were written or false if they already existed

getTestDefs

public com.mongodb.DBCursor getTestDefs(boolean active,
                                        int skip,
                                        int count)

Parameters:

count - the number of results to retrieve (must be greater than zero)

Returns:

a list of tests, active or all

getTestDef

public com.mongodb.DBObject getTestDef(String release,
                                       Integer schema)

Retrieve a specific (and full) test definition

Parameters:

release - the test definition software release

schema - the schema number

Returns:

the test definition or null if not found

getTests

public com.mongodb.DBCursor getTests(String release,
                                     Integer schema,
                                     int skip,
                                     int count)

Get a list of all defined tests

Parameters:

release - the test definition software release or null for all test releases

schema - the schema number or null for all schemas

Returns:

all the currently-defined tests

getTest

public com.mongodb.DBObject getTest(org.bson.types.ObjectId testObjId,
                                    boolean includeProperties)

Retrieve the data for given test

Parameters:

testObjId - the ID of the test

includeProperties - true to flesh out the properties

Returns:

the test object or null if not found

getTest

public com.mongodb.DBObject getTest(String test,
                                    boolean includeProperties)

Retrieve the data for given test

Parameters:

test - the test name

includeProperties - true to flesh out the properties

Returns:

the test object or null if not found

copyTest

public boolean copyTest(String test,
                        String release,
                        Integer schema,
                        String copyOfTest,
                        int copyOfVersion)

Create a new test by copying an existing test.

All property overrides will be copied, which is where the value really lies. Test runs are not copied.

Parameters:

name - a globally-unique name using ConfigConstants#TEST_NAME_REGEX

release - the test definition software release or null to use the same release as the source test

schema - the schema number or null to use the same schema as the source test

copyOfTest - the test name to copy

copyOfVersion - the version of the test to copy

Returns:

true if the test was copied or false if not

createTest

public boolean createTest(String test,
                          String description,
                          String release,
                          Integer schema)

Create a new test for the precise release and schema

Parameters:

test - a globally-unique name using ConfigConstants#TEST_NAME_REGEX

description - any description

release - the test definition software release

schema - the schema number

Returns:

true if the test was written other false if not

updateTest

public boolean updateTest(String name,
                          int version,
                          String newName,
                          String newDescription,
                          String newRelease,
                          Integer newSchema)

Update an existing test to use new test details

Parameters:

name - the name of the test (must exist)

version - the version of the test for concurrency checking

newName - the new test name

newDescription - the new description or null ot leave it

newRelease - the new software release or null to leave it

newSchema - the new schema number or null to leave it

Returns:

true if the test run was modified or false if not

deleteTest

public boolean deleteTest(String test)

Delete an existing test

Parameters:

test - the name of the test (must exist)

Returns:

true if the test was deleted or false if not

getTestRunNames

public List<String> getTestRunNames(String test)

Get the test run names associated with a given test

Parameters:

test - the name of the test

Returns:

the names of all test runs associated with the given test

getTestRuns

public com.mongodb.DBCursor getTestRuns(String test,
                                        int skip,
                                        int count,
                                        TestRunState... testRunStates)

Parameters:

test - only fetch runs for this test or null to get all test runs

testRunStates - optional states that the test runs must be in or empty for all

Returns:

a cursor onto the test runs for the given test

getTestRun

public com.mongodb.DBObject getTestRun(org.bson.types.ObjectId runObjId,
                                       boolean includeProperties)
                                throws ObjectNotFoundException

Retrieve the data for given test run

Parameters:

runObjId - (ObjectId, mandatory) the ID of the test run

includeProperties - true to flesh out all the properties

Returns:

the test object

Throws:

ObjectNotFoundException

getTestRunPropertiesMap

public Map<String,com.mongodb.DBObject> getTestRunPropertiesMap(org.bson.types.ObjectId testObjId,
                                                                org.bson.types.ObjectId runObjId,
                                                                String testName,
                                                                String testRunName)
                                                         throws ObjectNotFoundException

Returns the map with "final" test run properties of the test run.

Parameters:

testObjId - (ObjectId, optional)

runObjId - (ObjectId, optional)

testName - (String, mandatory)

testRunName - (String, mandatory)

Returns:

(Map) or exception

Throws:

ObjectNotFoundException

getTestPropertiesMap

public Map<String,com.mongodb.DBObject> getTestPropertiesMap(org.bson.types.ObjectId testObjId,
                                                             String testName)
                                                      throws ObjectNotFoundException

Returns the map with "final" test run properties of the test run.

Parameters:

testObjId - (ObjectId, optional)

testName - (String, mandatory)

Returns:

(Map) or exception

Throws:

ObjectNotFoundException

getTestRun

public com.mongodb.DBObject getTestRun(String test,
                                       String run,
                                       boolean includeProperties)
                                throws ObjectNotFoundException

Retrieve the data for given test run

Parameters:

test - (String, mandatory) the name of the test

run - (String, mandatory) the test run name

includeProperties - true to flesh out all the properties

Returns:

(DBObject) the test object

Throws:

ObjectNotFoundException

copyTestRun

public boolean copyTestRun(String test,
                           String run,
                           String copyOfRun,
                           int copyOfVersion)

Create a new test run by copying an existing test run.

All property overrides will be copied, which is where the value really lies.

Parameters:

test - the name of the test to which the run belongs

run - a test-unique name using ConfigConstants#RUN_NAME_REGEX

copyOfRun - the test run name to copy

copyOfVersion - the version of the test run to copy

Returns:

true if the test run was copied or false if not

createTestRun

public boolean createTestRun(String test,
                             String run,
                             String description)

Create a new test run

Parameters:

test - the name of the test to which the run belongs

run - a test-unique name using ConfigConstants#RUN_NAME_REGEX

description - any description

Returns:

true if the test run was written other false if not

updateTestRun

public boolean updateTestRun(String test,
                             String run,
                             int version,
                             String newName,
                             String newDescription)

Update an existing test run with new details

Parameters:

test - the name of the test

run - the name of the test run (must exist)

version - the version of the test for concurrency checking

newName - the new name of the test run

newDescription - the new description or null ot leave it

Returns:

true if the test run was modified or false if not

updateTestRunState

public boolean updateTestRunState(org.bson.types.ObjectId runId,
                                  int version,
                                  TestRunState testRunState,
                                  Long scheduled,
                                  Long started,
                                  Long stopped,
                                  Long completed,
                                  Long duration,
                                  Double progress,
                                  Long resultsSuccess,
                                  Long resultsFail)

Update the run state of a test run.

The test run state will be set based on the values.

Note that a test run can either be stopped or completed but not both. In both cases, though, the test run must have been scheduled and then started.

Parameters:

test - the name of the test

run - the name of the test run (must exist)

version - the version of the test for concurrency checking

testRunState - the test run state to set ( to ignore)

scheduled - the time when the test run is scheduled to start ( to ignore)

started - the time when the test run started ( to ignore)

stopped - the time when the test run was stopped ( to ignore)

completed - the time when the test run was completed ( to ignore)

duration - the time the test has been running for in ms ( to ignore)

progress - the new progress for the test run ( to ignore)

resultsSuccess - the number of successful results ( to ignore)

resultsFailure - the number of failed results ( to ignore)

Returns:

true if the test run was modified or false if not

addTestRunDriver

public void addTestRunDriver(org.bson.types.ObjectId runObjId,
                             String driverId)

Register a driver with a test run

Parameters:

runObjId - the ID of the test run

driverId - the ID of the driver to include

removeTestRunDriver

public void removeTestRunDriver(org.bson.types.ObjectId runObjId,
                                String driverId)

Derigister a driver from a test run

Parameters:

runObjId - the ID of the test run

driverId - the ID of the driver to remove

deleteTestRun

public boolean deleteTestRun(org.bson.types.ObjectId runObjId)

Delete an existing test run

Parameters:

runObjId - the ID of the test run

Returns:

true if the test run was deleted or false if not

deleteTestRun

public boolean deleteTestRun(String test,
                             String run)

Delete an existing test run

Parameters:

test - the name of the test

run - the run name (must exist)

Returns:

true if the test run was deleted or false if not

getProperty

public com.mongodb.DBObject getProperty(String test,
                                        String run,
                                        String propertyName)

Retrieve the effective property for a given test, test run and property name.

This combines all values in the property inheritance hierarchy to get to the value applicable to the test or test run.

Parameters:

test - the name of the test

run - the name of the run or null to find the value for the test only

propertyName - the name of the property (never null)

Returns:

the property for the test or null if it does not exist

setPropertyOverride

public boolean setPropertyOverride(String test,
                                   String run,
                                   String propertyName,
                                   int version,
                                   String value)

Override a specific test property value.

A version number of zero indicates that there is no existing override defined.
A value of null indicates that the existing override should be removed.

Parameters:

test - the name of the test

run - the name of the test run (null to reference the test alone)

propertyName - the name of the property

version - the current version of the property

value - the new value to set or null to remove any override

Throws:

IllegalStateException - if the test has started

lockProperties

public void lockProperties(org.bson.types.ObjectId testObjId,
                           org.bson.types.ObjectId runObjId)
                    throws ObjectNotFoundException

Record a final set of locked properties for a test run. The properties written will not be updatable.

Parameters:

testObjId - the ID of the test

runObjId - the ID of the test run

Throws:

ObjectNotFoundException

getMaskedProperyNames

public Set<String> getMaskedProperyNames(String release,
                                         Integer schema)
                                  throws ObjectNotFoundException

Fetch masked property names (passwords) by release and version name.

Parameters:

release - (String, mandatory) test release name

version - (Integer) test version number

Returns:

(Set) or exception

Throws:

ObjectNotFoundException

Since:

2.1.2

isMaskedProperty

public boolean isMaskedProperty(com.mongodb.DBObject property)

Checks if the DBObject contains a field FIELD_MASK and returns true if set

Parameters:

property - (DBObject) property

Returns:

true if masked, false if not or field not contained.

getMaskedProperyNames

public Set<String> getMaskedProperyNames(String testName)
                                  throws ObjectNotFoundException

Fetch masked property names (passwords) by test name.

Parameters:

testName - (String, mandatory) test name

Returns:

(Set) or exception

Throws:

ObjectNotFoundException

Since:

2.1.2

importTest

public com.mongodb.DBObject importTest(String testName,
                                       com.mongodb.DBObject importObj)

Imports the properties of a test from JSON.

Parameters:

testName - (String, mandatory) test name to import properties to

importObj - (DBObject, mandatory) properties to import

Returns:

(DBObject) Result and message

importTestRun

public com.mongodb.DBObject importTestRun(String testName,
                                          String runName,
                                          com.mongodb.DBObject importObj)

getPropValueAsString

public String getPropValueAsString(com.mongodb.DBObject dbPropertyObj)

Returns the value or default of the property as string

Parameters:

dbPropertyObj - (DBObject) property to read

Returns:

Either value (if set) or default (if present) or an empty string

exportTest

public com.mongodb.DBObject exportTest(String testName)
                                throws ObjectNotFoundException,
                                       CipherException

Exports the test with properties as JSON

Parameters:

testName - (string, mandatory) name of the test to export

Returns:

DBObject to serialize as JSON

Throws:

ObjectNotFoundException

CipherException

exportTestRun

public com.mongodb.DBObject exportTestRun(String testName,
                                          String runName)
                                   throws ObjectNotFoundException,
                                          CipherException

Exports a test run with encrypted password properties by test and run name.

Parameters:

testName - (String, mandatory) test name

runName - (String, mandatory) run name

Returns:

(DBObject) or exception

Throws:

ObjectNotFoundException

CipherException

Since:

2.1.2

encryptPropertyValue

public com.mongodb.DBObject encryptPropertyValue(com.mongodb.DBObject dbObject,
                                                 String propName)
                                          throws CipherException

Encrypts property DB object

Parameters:

dbObject - (DBObject, mandatory)

propName - (String, mandatory) name of the property

Returns:

(DBObject) where fields 'FIELD_DEFAULT' and 'FIELD_VALUE' are encrypted.

Throws:

CipherException

decryptPropertyValue

public com.mongodb.DBObject decryptPropertyValue(com.mongodb.DBObject dbObject,
                                                 String propName)
                                          throws CipherException

Decrypt property if encrypted

Parameters:

dbObject - (DBObject, mandatory) Property, that might be encrypted

propName - (String, mandatory) Name of the property

Returns:

(DBObject) where fields 'FIELD_DEFAULT' and 'FIELD_VALUE' are no longer encrypted.

Throws:

CipherException