MESUnitTestUtils (mes-core 0.5 API)

org.simplemes.mes.test.MESUnitTestUtils

```
class MESUnitTestUtils
extends java.lang.Object
```
Convenience utilities for MES unit tests. Used to create common data structures. Can also be used for GUI/Integration tests with proper transaction settings. Currently, you should use the static methods. The internal instance methods are used to allow sub-classing.

Properties Summary

Properties
Type	Name and description
`private static MESUnitTestUtils`	`instance` A singleton, used to allow sub-classes to provide additional features.
`private static java.lang.String`	`originalUserOverride`

Constructor Summary

Constructors
Constructor and description
`MESUnitTestUtils ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`adjustOperation(ProductOperation operation, java.util.Map options)` Allows sub-classes to adjust the ProductOperation before it is saved.
	`protected void`	`adjustOperation(MasterOperation operation, java.util.Map options)` Allows sub-classes to adjust the MasterOperation before it is saved.
	`protected void`	`adjustOrder(Order order, java.util.Map options)` Allows sub-classes to adjust the Order before it is saved.
	`protected void`	`adjustProduct(Product product, java.util.Map options)` Allows sub-classes to adjust the Product before it is saved.
	`static MasterRouting`	`buildMasterRouting(java.util.Map options)` Build a simple master routing the given operations.
	`static Product`	`buildSimpleProductWithRouting(java.util.Map options)` Build a product with a simple 3 operation routing for use in an product.
	`static void`	`clearLoginUser()` Resets the user override to the value we found on setLoginUser().
	`protected void`	`forceQtyDone(Order order, BigDecimal qtyDone)` Forces the qty to done for the given order (and LSNs if any).
	`protected void`	`forceQtyInWork(Order order, BigDecimal qtyInWork)` Forces the qty to in work for the given order (and LSNs if any).
	`static java.lang.Object`	`loadOrderInitialDataNeeded(java.util.Map options)` Loads any initial data needed for order release.
	`static Order`	`releaseOrder(java.util.Map options)` Create and release a single order, optionally on a routing with or without LSNs.
	`static java.util.List<Order>`	`releaseOrders(java.util.Map options)` Create and release orders, optionally on a routing with or without LSNs.
	`protected java.util.List<Order>`	`releaseOrdersInternal(java.util.Map options)` Internal create and release orders.
	`static java.lang.Object`	`resetCodeSequences()` Resets all of the codeSequences for the test database.
	`static java.lang.Object`	`resetSequence(java.lang.Class sequenceClass, long newSequence)` Resets the currentSequence for thie given CodeSequenceTrait to the given sequence.
	`protected long`	`setDates(WorkStateTrait workState, long timeStamp)` Sets the date queued/started (if already set) to the given timestamp and then increments the timestamp.
	`static void`	`setLoginUser()` Sets the current user for order release and other actions.
	`protected void`	`spreadDates(java.util.List<Order> orders)` Utility method to set the dates queued/started to a known value for a list of orders/LSNs.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - private static MESUnitTestUtils instance
    
    A singleton, used to allow sub-classes to provide additional features.
  - private static java.lang.String originalUserOverride
- Constructor Detail
  - MESUnitTestUtils()
- Method Detail
  - @java.lang.SuppressWarnings(value: unused) protected void adjustOperation(ProductOperation operation, java.util.Map options)
    
    Allows sub-classes to adjust the ProductOperation before it is saved.
    Parameters:
    operation - The un-saved operation.
    options - the options for the order release.
  - @java.lang.SuppressWarnings(value: unused) protected void adjustOperation(MasterOperation operation, java.util.Map options)
    
    Allows sub-classes to adjust the MasterOperation before it is saved.
    Parameters:
    operation - The un-saved operation.
    options - the options for the order release.
  - @java.lang.SuppressWarnings(value: unused) protected void adjustOrder(Order order, java.util.Map options)
    
    Allows sub-classes to adjust the Order before it is saved.
    Parameters:
    product - The un-saved order.
    options - the options for the order release.
  - @java.lang.SuppressWarnings(value: unused) protected void adjustProduct(Product product, java.util.Map options)
    
    Allows sub-classes to adjust the Product before it is saved.
    Parameters:
    product - The un-saved product.
    options - the options for the order release.
  - static MasterRouting buildMasterRouting(java.util.Map options)
    
    Build a simple master routing the given operations.
    Options
    The options can be:
    - operations - A List of operation sequences (Integers). (Default: [1,2,3])
    - id - A semi-unique ID to help identify records created by this method (Default: '')
    Parameters:
    options - The options used to build the routing.
    Returns:
    The master routing.
  - static Product buildSimpleProductWithRouting(java.util.Map options)
    
    Build a product with a simple 3 operation routing for use in an product.
    Options
    The options can be:
    - product - The product to create. (Default: 'PC')
    - operations - A List of operation sequences (Integers). (Default: [1,2,3])
    - lsnTrackingOption - Configures the LSN option (Default: LSNTrackingOption.ORDER_ONLY)
    Note: If the lsnTrackingOption is LSNTrackingOption.LSN_ONLY, then default LSNSequence is used for the product.
    Parameters:
    options - The options used to build the product. Supports operations(List of sequences (integers))
    Returns:
    The product.
  - static void clearLoginUser()
    
    Resets the user override to the value we found on setLoginUser().
  - protected void forceQtyDone(Order order, BigDecimal qtyDone)
    
    Forces the qty to done for the given order (and LSNs if any).
    Parameters:
    order - The order.
    qtyDone - The qty to take from inQueue and move to done. Only moved if the qtyInQueue is large enough.
  - protected void forceQtyInWork(Order order, BigDecimal qtyInWork)
    
    Forces the qty to in work for the given order (and LSNs if any).
    Parameters:
    order - The order.
    qtyInWork - The qty to take from inQueue and move to in work. Only moved if the qtyInQueue is large enough.
  - static java.lang.Object loadOrderInitialDataNeeded(java.util.Map options)
    
    Loads any initial data needed for order release. Always loads the OrderStatus.
    Parameters:
    options - Uses the lsnTrackingOption to decide if LSN Sequence and Status must be loaded.
  - static Order releaseOrder(java.util.Map options)
    
    Create and release a single order, optionally on a routing with or without LSNs. This is a convenience function that calls releaseOrders(java.util.Map).
    This method creates a transaction (if needed)..
    Parameters:
    options - See for the releaseOrders(java.util.Map) for details. (Optional)
    Returns:
    The order(s) created and released.
  - static java.util.List<Order> releaseOrders(java.util.Map options)
    
    Create and release orders, optionally on a routing with or without LSNs.
    This method creates a transaction (if needed)..
    Options
    The options can be:
    - id - A semi-unique ID to help identify records created by this method (Default: '')
    - nOrders - The number of orders to create (Default: 1)
    - operations - A List of operation sequences (Integers). This list is sorted in reverse order before save(). (Default: No routing)
    - masterRouting - The name of the master routing to create for this order. Will use the unique ID in the key. (Default: No routing)
    - productName - The name of the product for the order. (Default: No product unless Operations or LSN tracking is set)
    - qty - The number of pieces to build for each order (Default: 1.0)
    - qtyInWork - The number of pieces to move to in work (Default: 0.0). Allows easy testing of inWork orders.
    - qtyDone - The number of pieces to move to qtyDone (Default: 0.0). Allows easy testing of completed orders.
    - lotSize - The size of each LSN created (if configured for LSNs) (Default: 1.0)
    - lsnTrackingOption - Configures the LSN option (Default: LSNTrackingOption.ORDER_ONLY)
    - lsnSequence - The LSN Sequence to use to generate the LSN names (Default: default LSN Sequence)
    - lsns - A list of LSN names (Strings) to use for the order. LSNs are created using this and the order # (if nOrders>1). (Default: default LSN Sequence)
    - spreadQueuedDates - If true, then the dateFirstQueued for all created objects will be spread from a date 14 days ago (+1 second for each). (Default: false)
    - orderSequenceStart - The sequence number for the first order created (Default: 1000)
    Note: If the lsnTrackingOption is LSNTrackingOption.LSN_ONLY, then an LSNSequence is used for the product.
    Note: The records created by this utility should be cleaned up using this option (for sub-classes of the test specs).
```
   static dirtyDomains = [ActionLog, Order, Product]
 
```
    Parameters:
    options - See options above. (Optional)
    Returns:
    The order(s) created and released.
  - @java.lang.SuppressWarnings(value: AbcMetric) protected java.util.List<Order> releaseOrdersInternal(java.util.Map options)
    
    Internal create and release orders. This is used as a non-static method to allow sub-classes to alter the objects created.
    This method creates a transaction (if needed)..
    Parameters:
    options - See for the releaseOrders(java.util.Map) for details. (Optional)
    Returns:
    The order(s) created and released.
  - static java.lang.Object resetCodeSequences()
    
    Resets all of the codeSequences for the test database.
  - static java.lang.Object resetSequence(java.lang.Class sequenceClass, long newSequence)
    
    Resets the currentSequence for thie given CodeSequenceTrait to the given sequence. This is used to clean up after tests
    Parameters:
    sequenceClass - The sequence to reset all sequences for.
    newSequence - The new current sequence to use. (Default: 1000)
  - protected long setDates(WorkStateTrait workState, long timeStamp)
    
    Sets the date queued/started (if already set) to the given timestamp and then increments the timestamp.
    Parameters:
    workState - The state object to update.
    timeStamp - The time to set the dates to.
    Returns:
    The updated timestamp.
  - static void setLoginUser()
    
    Sets the current user for order release and other actions.
  - @java.lang.SuppressWarnings(value: GroovyAssignabilityCheck) protected void spreadDates(java.util.List<Order> orders)
    
    Utility method to set the dates queued/started to a known value for a list of orders/LSNs. Processes all LSNs in the orders for all possible routing steps.
    Parameters:
    orders - The orders to set the dates on.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class MESUnitTestUtils

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private static MESUnitTestUtils instance

private static java.lang.String originalUserOverride

Constructor Detail

MESUnitTestUtils()

Method Detail

@java.lang.SuppressWarnings(value: unused) protected void adjustOperation(ProductOperation operation, java.util.Map options)

@java.lang.SuppressWarnings(value: unused) protected void adjustOperation(MasterOperation operation, java.util.Map options)

@java.lang.SuppressWarnings(value: unused) protected void adjustOrder(Order order, java.util.Map options)

@java.lang.SuppressWarnings(value: unused) protected void adjustProduct(Product product, java.util.Map options)

static MasterRouting buildMasterRouting(java.util.Map options)

Options

static Product buildSimpleProductWithRouting(java.util.Map options)

Options

static void clearLoginUser()

protected void forceQtyDone(Order order, BigDecimal qtyDone)

protected void forceQtyInWork(Order order, BigDecimal qtyInWork)

static java.lang.Object loadOrderInitialDataNeeded(java.util.Map options)

static Order releaseOrder(java.util.Map options)

static java.util.List<Order> releaseOrders(java.util.Map options)

Options

@java.lang.SuppressWarnings(value: AbcMetric) protected java.util.List<Order> releaseOrdersInternal(java.util.Map options)

static java.lang.Object resetCodeSequences()

static java.lang.Object resetSequence(java.lang.Class sequenceClass, long newSequence)

protected long setDates(WorkStateTrait workState, long timeStamp)

static void setLoginUser()

@java.lang.SuppressWarnings(value: GroovyAssignabilityCheck) protected void spreadDates(java.util.List<Order> orders)