com.indeed.proctor.store

Class FileBasedProctorStore

java.lang.Object

com.indeed.proctor.store.FileBasedProctorStore

All Implemented Interfaces:

ProctorReader, ProctorStore, ProctorWriter, Closeable, AutoCloseable

Direct Known Subclasses:

LocalDirectoryStore

public abstract class FileBasedProctorStore
extends Object
implements ProctorStore

Author:

ketan, parker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileBasedProctorStore.ProctorUpdater
static interface	FileBasedProctorStore.RcsClient

Field Summary

Fields

Modifier and Type	Field and Description
protected FileBasedPersisterCore	core
static String	DEFAULT_TEST_DEFINITIONS_DIRECTORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileBasedProctorStore(FileBasedPersisterCore core)
protected	FileBasedProctorStore(FileBasedPersisterCore core, String testDefinitionsDirectory)

Method Summary

Modifier and Type	Method and Description
void	addTestDefinition(ChangeMetadata changeMetadata, String testName, TestDefinition testDefinition, Map<String,String> metadata) Add new test definition to this store.
void	close()
void	deleteTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition)
FileBasedPersisterCore	getCore()
TestDefinition	getCurrentTestDefinition(String testName)
TestMatrixVersion	getCurrentTestMatrix()
TestDefinition	getTestDefinition(String testName, String fetchRevision)
TestMatrixVersion	getTestMatrix(String fetchRevision)
void	shutdown()
void	updateTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata) Updates a test with testName that already exists in this store Fails with Exception when testName does not exist, or neither testDefinition nor metadata has changes to current version
protected <T> boolean	updateThing(FileBasedProctorStore.RcsClient rcsClient, File file, T thing)
protected static <T> boolean	writeIfChanged(File f, T newThing)
protected static <T> void	writeThing(File f, T newThing)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.indeed.proctor.store.ProctorStore

getName

Methods inherited from interface com.indeed.proctor.store.ProctorReader

getAllHistories, getHistory, getHistory, getLatestVersion, getMatrixHistory, getMatrixHistory, getRevisionDetails, getTestEdits, getTestEdits, refresh, verifySetup

Methods inherited from interface com.indeed.proctor.store.ProctorWriter

addTestDefinition, addTestDefinition, cleanUserWorkspace, deleteTestDefinition, deleteTestDefinition, updateTestDefinition, updateTestDefinition, verifySetup

Field Detail

DEFAULT_TEST_DEFINITIONS_DIRECTORY

public static final String DEFAULT_TEST_DEFINITIONS_DIRECTORY

See Also:

Constant Field Values

core

protected final FileBasedPersisterCore core

Constructor Detail

FileBasedProctorStore

protected FileBasedProctorStore(FileBasedPersisterCore core,
                                String testDefinitionsDirectory)

FileBasedProctorStore

protected FileBasedProctorStore(FileBasedPersisterCore core)

Method Detail

writeIfChanged

protected static <T> boolean writeIfChanged(File f,
                                            T newThing)
                                     throws StoreException.TestUpdateException

Returns:

true if the file has changed

Throws:

StoreException.TestUpdateException

writeThing

protected static <T> void writeThing(File f,
                                     T newThing)
                              throws StoreException.TestUpdateException

Throws:

StoreException.TestUpdateException

getCurrentTestMatrix

public TestMatrixVersion getCurrentTestMatrix()
                                       throws StoreException

Specified by:

getCurrentTestMatrix in interface ProctorReader

Returns:

the current test matrix in the database.

Throws:

StoreException

getCore

public FileBasedPersisterCore getCore()

getTestMatrix

public final TestMatrixVersion getTestMatrix(String fetchRevision)
                                      throws StoreException

Specified by:

getTestMatrix in interface ProctorReader

Parameters:

fetchRevision - id of the revision

Returns:

a test matrix when the revision was made.

Throws:

StoreException - if the revision is not found.

getCurrentTestDefinition

public TestDefinition getCurrentTestDefinition(String testName)
                                        throws StoreException

Specified by:

getCurrentTestDefinition in interface ProctorReader

Parameters:

testName - name of the test.

Returns:

a current test definition of a test in the database. null if the test is not found in the current state.

Throws:

StoreException

getTestDefinition

public TestDefinition getTestDefinition(String testName,
                                        String fetchRevision)
                                 throws StoreException

Specified by:

getTestDefinition in interface ProctorReader

Parameters:

testName - name of the test

fetchRevision - id of the revision

Returns:

a test definition of a test when the revision was made. null if the test is not found at the revision

Throws:

StoreException - if the revision is not found.

shutdown

public void shutdown()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

updateThing

protected final <T> boolean updateThing(FileBasedProctorStore.RcsClient rcsClient,
                                        File file,
                                        T thing)
                                 throws Exception

Throws:

Exception

updateTestDefinition

public final void updateTestDefinition(ChangeMetadata changeMetadata,
                                       String previousVersion,
                                       String testName,
                                       TestDefinition testDefinition,
                                       Map<String,String> metadata)
                                throws StoreException.TestUpdateException

Description copied from interface: ProctorWriter

Updates a test with testName that already exists in this store Fails with Exception when testName does not exist, or neither testDefinition nor metadata has changes to current version

Specified by:

updateTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

addTestDefinition

public final void addTestDefinition(ChangeMetadata changeMetadata,
                                    String testName,
                                    TestDefinition testDefinition,
                                    Map<String,String> metadata)
                             throws StoreException.TestUpdateException

Description copied from interface: ProctorWriter

Add new test definition to this store. Fails with Exception when testName already exists

Specified by:

addTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException - on invalid inputs

deleteTestDefinition

public final void deleteTestDefinition(ChangeMetadata changeMetadata,
                                       String previousVersion,
                                       String testName,
                                       TestDefinition testDefinition)
                                throws StoreException.TestUpdateException

Specified by:

deleteTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException - when