com.indeed.proctor.store.utils.test

Class InMemoryProctorStore

java.lang.Object

com.indeed.proctor.store.utils.test.InMemoryProctorStore

All Implemented Interfaces:

ProctorReader, ProctorStore, ProctorWriter, Closeable, AutoCloseable

public class InMemoryProctorStore
extends Object
implements ProctorStore

This class is an in-memory implementation of ProctorStore. It's for testing purpose and not production ready.

These are design notes of this in-memory store.

Initially it stores following data * a single dummy revision in matrix history. * no test definition.

the dummy revision is required for the following purpose. * getLatestVersion() can avoid an exception even in initialized state. * getCurrent*() can avoid an exception as they relies on getLatestVersion()

With default constructor, Revision id is a sequential number. First revision id is "0" and first update will create a revision "1". If you want to control revision id generation (e.g. if you want to make sure it's unique in more than single stores), create and pass to the constructor your custom id generator.

Internally, it stores single data structures to support all queries. * globalHistory: a linked list of update records order by recency

Constructor Summary

Constructors

Constructor and Description
InMemoryProctorStore()
InMemoryProctorStore(Supplier<String> revisionIdGenerator)

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.
static Supplier<String>	autoincrementRevisionIdGenerator()
boolean	cleanUserWorkspace(String username)
void	close()
void	deleteTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition)
Map<String,List<Revision>>	getAllHistories() Get all the revisions for all tests in history Same revision may appear in two or more lists if multiple tests are modified in the revision.
TestDefinition	getCurrentTestDefinition(String testName)
TestMatrixVersion	getCurrentTestMatrix()
List<Revision>	getHistory(String testName, int start, int limit)
List<Revision>	getHistory(String testName, String revisionId, int start, int limit)
String	getLatestVersion()
List<Revision>	getMatrixHistory(Instant sinceInclusive, Instant untilExclusive)
List<Revision>	getMatrixHistory(int start, int limit)
String	getName() This method returns a name of the ProctorStore instance for logging purpose.
RevisionDetails	getRevisionDetails(String revisionId)
TestDefinition	getTestDefinition(String testName, String revisionId)
List<TestEdit>	getTestEdits(String testName, int start, int limit)
List<TestEdit>	getTestEdits(String testName, String revision, int start, int limit)
TestMatrixVersion	getTestMatrix(String revisionId)
void	refresh() Update the local state with the remote database.
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
void	verifySetup() Verifies the data store object is ready to operate.

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.ProctorWriter

addTestDefinition, addTestDefinition, deleteTestDefinition, deleteTestDefinition, updateTestDefinition, updateTestDefinition

Constructor Detail

InMemoryProctorStore

public InMemoryProctorStore()

InMemoryProctorStore

public InMemoryProctorStore(Supplier<String> revisionIdGenerator)

Method Detail

autoincrementRevisionIdGenerator

public static Supplier<String> autoincrementRevisionIdGenerator()

Returns:

default revision id generator that simulates autoincrement id in DB

getName

public String getName()

Description copied from interface: ProctorStore

This method returns a name of the ProctorStore instance for logging purpose.

Specified by:

getName in interface ProctorStore

getLatestVersion

@Nonnull
public String getLatestVersion()

Specified by:

getLatestVersion in interface ProctorReader

Returns:

the latest revision id.

getTestMatrix

public TestMatrixVersion getTestMatrix(String revisionId)
                                throws StoreException

Specified by:

getTestMatrix in interface ProctorReader

Parameters:

revisionId - id of the revision

Returns:

a test matrix when the revision was made.

Throws:

StoreException - if the revision is not found.

getTestDefinition

@CheckForNull
public TestDefinition getTestDefinition(String testName,
                                                      String revisionId)
                                               throws StoreException

Specified by:

getTestDefinition in interface ProctorReader

Parameters:

testName - name of the test

revisionId - 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.

getMatrixHistory

@Nonnull
public List<Revision> getMatrixHistory(int start,
                                                int limit)

Specified by:

getMatrixHistory in interface ProctorReader

Parameters:

start - offset of the first revision (0-indexed)

limit - limit of the number of revisions, -1 might be usable for unlimited (depending on implementation)

Returns:

a list of revisions for all tests ordered by recency.

getMatrixHistory

@Nonnull
public List<Revision> getMatrixHistory(Instant sinceInclusive,
                                                Instant untilExclusive)

Specified by:

getMatrixHistory in interface ProctorReader

Parameters:

sinceInclusive - earliest date

untilExclusive - latest date

Returns:

a list of revisions for a test when test revision was made ordered by recency.

getHistory

@Nonnull
public List<Revision> getHistory(String testName,
                                          String revisionId,
                                          int start,
                                          int limit)
                                   throws StoreException

Specified by:

getHistory in interface ProctorReader

Parameters:

testName - name of the test

start - offset of the first revision (0-indexed)

limit - limit of the number of revisions, -1 might be usable for unlimited (depending on implementation)

Returns:

a list of revisions for a test when test revision was made ordered by recency.

Throws:

StoreException - if the revision is not found.

getRevisionDetails

@CheckForNull
public RevisionDetails getRevisionDetails(String revisionId)
                                                 throws StoreException

Specified by:

getRevisionDetails in interface ProctorReader

Parameters:

revisionId - id of the revision

Returns:

details of the single revision. null if the revision is not found in the store.

Throws:

StoreException

getTestEdits

@Nonnull
public List<TestEdit> getTestEdits(String testName,
                                            int start,
                                            int limit)
                                     throws StoreException

Specified by:

getTestEdits in interface ProctorReader

Parameters:

testName - to get test edits

start - offset of the first revision (0-indexed)

limit - limit of the number of test edits

Returns:

a list of test edits for a test when test revision was made ordered by recency.

Throws:

StoreException - if the revision is not found

getTestEdits

@Nonnull
public List<TestEdit> getTestEdits(String testName,
                                            String revision,
                                            int start,
                                            int limit)
                                     throws StoreException

Specified by:

getTestEdits in interface ProctorReader

Parameters:

testName - to get test edits

revision - from which the search of test edit is initiated

start - offset of the first revision (0-indexed)

limit - limit of the number of test edits

Returns:

a list of test edits for a test when test revision was made ordered by recency.

Throws:

StoreException - if the revision is not found

getAllHistories

@Nonnull
public Map<String,List<Revision>> getAllHistories()

Description copied from interface: ProctorReader

Get all the revisions for all tests in history Same revision may appear in two or more lists if multiple tests are modified in the revision.

Specified by:

getAllHistories in interface ProctorReader

Returns:

a list of revisions grouped by a test. Each list is ordered by recency.

getCurrentTestMatrix

public TestMatrixVersion getCurrentTestMatrix()
                                       throws StoreException

Specified by:

getCurrentTestMatrix in interface ProctorReader

Returns:

the current test matrix in the database.

Throws:

StoreException

getCurrentTestDefinition

@CheckForNull
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

getHistory

@Nonnull
public List<Revision> getHistory(String testName,
                                          int start,
                                          int limit)
                                   throws StoreException

Specified by:

getHistory in interface ProctorReader

Parameters:

testName - name of the test

start - offset of the first revision (0-indexed)

limit - limit of the number of revisions, -1 might be usable for unlimited (depending on implementation)

Returns:

a list of revisions for a test ordered by recency.

Throws:

StoreException

addTestDefinition

public 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

updateTestDefinition

public 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

deleteTestDefinition

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

Specified by:

deleteTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException - when

cleanUserWorkspace

public boolean cleanUserWorkspace(String username)

Specified by:

cleanUserWorkspace in interface ProctorWriter

verifySetup

public void verifySetup()

Description copied from interface: ProctorReader

Verifies the data store object is ready to operate. Throwing an exception allows the implementer to signal bad health status.

Specified by:

verifySetup in interface ProctorReader

Specified by:

verifySetup in interface ProctorWriter

refresh

public void refresh()

Description copied from interface: ProctorReader

Update the local state with the remote database.

Specified by:

refresh in interface ProctorReader

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable