AssyUnitTestUtils (mes-assy 0.5 API)

org.simplemes.mes.assy.test.AssyUnitTestUtils

```
class AssyUnitTestUtils
extends org.simplemes.mes.test.MESUnitTestUtils
```
Convenience utilities for MES Assy module unit tests. Used to create common data structures. Can also be used for GUI/Integration tests with proper transaction settings.
Note: These methods should only be used in Tests.

Inherited fields
Fields inherited from class	Fields
`class org.simplemes.mes.test.MESUnitTestUtils`	`__$stMC`

Properties Summary

Properties
Type	Name and description
`private static AssyUnitTestUtils`	`instance` A singleton, used to allow sub-classes to provide additional features.

Constructor Summary

Constructors
Constructor and description
`AssyUnitTestUtils ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`adjustProduct(org.simplemes.mes.product.domain.Product product, java.util.Map options)` Allows sub-classes to adjust the Product before it is saved.
	`static OrderAssembledComponent`	`assembleComponent(org.simplemes.mes.demand.domain.Order order, java.util.Map options)` Assembles a single component onto the order/LSN.
	`static groovy.lang.Tuple2<ScanRequest, ScanResponse>`	`buildRequestAndResponse(java.util.Map<java.lang.String, java.lang.Object> options)` Builds a parsed, but not resolved scan response/request for the given order with a LOT
	`static org.simplemes.mes.demand.domain.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 with product components with or without LSNs.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.simplemes.mes.test.MESUnitTestUtils`	org.simplemes.mes.test.MESUnitTestUtils#getInstance(), org.simplemes.mes.test.MESUnitTestUtils#buildSimpleProductWithRouting(java.util.Map), org.simplemes.mes.test.MESUnitTestUtils#buildSimpleProductWithRouting(), org.simplemes.mes.test.MESUnitTestUtils#buildMasterRouting(), org.simplemes.mes.test.MESUnitTestUtils#buildMasterRouting(java.util.Map), org.simplemes.mes.test.MESUnitTestUtils#releaseOrder(), org.simplemes.mes.test.MESUnitTestUtils#releaseOrder(java.util.Map), org.simplemes.mes.test.MESUnitTestUtils#releaseOrders(), org.simplemes.mes.test.MESUnitTestUtils#releaseOrders(java.util.Map), org.simplemes.mes.test.MESUnitTestUtils#loadOrderInitialDataNeeded(java.util.Map), org.simplemes.mes.test.MESUnitTestUtils#resetCodeSequences(), org.simplemes.mes.test.MESUnitTestUtils#resetSequence(java.lang.Class, long), org.simplemes.mes.test.MESUnitTestUtils#resetSequence(java.lang.Class), org.simplemes.mes.test.MESUnitTestUtils#setLoginUser(), org.simplemes.mes.test.MESUnitTestUtils#clearLoginUser(), org.simplemes.mes.test.MESUnitTestUtils#getOriginalUserOverride(), org.simplemes.mes.test.MESUnitTestUtils#setOriginalUserOverride(java.lang.String), org.simplemes.mes.test.MESUnitTestUtils#setInstance(org.simplemes.mes.test.MESUnitTestUtils), org.simplemes.mes.test.MESUnitTestUtils#getMetaClass(), org.simplemes.mes.test.MESUnitTestUtils#setMetaClass(groovy.lang.MetaClass), org.simplemes.mes.test.MESUnitTestUtils#wait(long, int), org.simplemes.mes.test.MESUnitTestUtils#wait(), org.simplemes.mes.test.MESUnitTestUtils#wait(long), org.simplemes.mes.test.MESUnitTestUtils#equals(java.lang.Object), org.simplemes.mes.test.MESUnitTestUtils#toString(), org.simplemes.mes.test.MESUnitTestUtils#hashCode(), org.simplemes.mes.test.MESUnitTestUtils#getClass(), org.simplemes.mes.test.MESUnitTestUtils#notify(), org.simplemes.mes.test.MESUnitTestUtils#notifyAll(), org.simplemes.mes.test.MESUnitTestUtils#getProperty(java.lang.String), org.simplemes.mes.test.MESUnitTestUtils#setProperty(java.lang.String, java.lang.Object), org.simplemes.mes.test.MESUnitTestUtils#invokeMethod(java.lang.String, java.lang.Object)

- Property Detail
  - private static AssyUnitTestUtils instance
    
    A singleton, used to allow sub-classes to provide additional features.
- Constructor Detail
  - AssyUnitTestUtils()
- Method Detail
  - @java.lang.Override protected void adjustProduct(org.simplemes.mes.product.domain.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 OrderAssembledComponent assembleComponent(org.simplemes.mes.demand.domain.Order order, java.util.Map options)
    
    Assembles a single component onto the order/LSN. This is designed to be used only in tests.
    This method creates a transaction (if needed)..
    Options
    The options can be:
    - sequence - The component sequence. If not given, then non-BOM is assumed (Optional)
    - bomSequence - The BOM record component sequence to assemble. If not given, then the sequence is used (Optional)
    - qty - The number of pieces to assemble If no qty is specified, then the BOM component QTY is multiplied by the LSN.qty or the Order.qtyToBuild (Optional)
    - lsn - The LSN to assemble the component for (Optional).
    - component - The component to assemble. Required for non-BOM components.
    - assemblyDataType - The assembly data flex type to use (Optional).
    - assemblyDataValues - The assembly data values to use for the component. A Map of name/value pairs (Optional).
    - removed - If true, then the component will be marked as removed.
    Parameters:
    order - The order to assemble a component for.
    options - The options. See above.
    Returns:
    The assembled component record.
  - static groovy.lang.Tuple2<ScanRequest, ScanResponse> buildRequestAndResponse(java.util.Map<java.lang.String, java.lang.Object> options)
    
    Builds a parsed, but not resolved scan response/request for the given order with a LOT
    Parameters:
    options - Contains elements for the response: order/lsn, component and optional lot, vendor.
    Returns:
    A scan request and scan response.
  - static org.simplemes.mes.demand.domain.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)..
    Options
    See MESUnitTestUtils#releaseOrders(java.util.Map) for other options. The options can be:
    - components - A List of component names (Strings). Sequence and Qty are incremented (Default: No components or product used).
    - assemblyDataType - The FlexType to use for assembly data for all components. Requires the addition to be loaded: ArtefactTstUtils.addAdditionArtefactsForTest([AssemblyAddition])
    - reverseSequences - If true, then will assign operation sequences by counting down.
    - product - The top-level product to built by the order (Default: PC)
    Note: For integration tests, 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, MasterRouting]
 
```
    Parameters:
    options - See options above. (Optional)
    Returns:
    The order(s) created and released.
  - static java.util.List<Order> releaseOrders(java.util.Map options)
    
    Create and release orders with product components with or without LSNs.
    This method creates a transaction (if needed)..
    Parameters:
    options - See for the releaseOrder(java.util.Map) for details. (Optional)
    Returns:
    The order(s) created and released.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AssyUnitTestUtils

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private static AssyUnitTestUtils instance

Constructor Detail

AssyUnitTestUtils()

Method Detail

@java.lang.Override protected void adjustProduct(org.simplemes.mes.product.domain.Product product, java.util.Map options)

static OrderAssembledComponent assembleComponent(org.simplemes.mes.demand.domain.Order order, java.util.Map options)

Options

static groovy.lang.Tuple2<ScanRequest, ScanResponse> buildRequestAndResponse(java.util.Map<java.lang.String, java.lang.Object> options)

static org.simplemes.mes.demand.domain.Order releaseOrder(java.util.Map options)

Options

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