Package com.google.appengine.tools.development.testing

Class LocalModulesServiceTestConfig

java.lang.Object
com.google.appengine.tools.development.testing.LocalModulesServiceTestConfig
All Implemented Interfaces:
LocalServiceTestConfig
public class LocalModulesServiceTestConfig extends Object implements LocalServiceTestConfig
Config for accessing the LocalModulesService in tests.

To understand the operation of LocalModulesServiceTestConfig please note that a number of ApiProxy.Environment settings affect the operation of ModulesService. For the test environment these settings are controlled using LocalServiceTestHelper:

  1. LocalServiceTestHelper.setEnvModuleId(java.lang.String) specifies the result returned by ModulesService.getCurrentModule(). The default module is "default".
  2. LocalServiceTestHelper.setEnvVersionId(java.lang.String) specifies the result returned by ModulesService.getCurrentVersion(). The default version is "1".
  3. LocalServiceTestHelper.setEnvInstance(java.lang.String) specifies the result returned by ModulesService.getCurrentInstanceId(). For manual scaling and basic scaling module versions you can explicitly specify a configured instance or if you prefer you can leave the default("-1") value and the testing framework will set the instance to 0. For automatic scaling module version you must leave the value as the default("-1").

The environment values for LocalServiceTestHelper must match a module, version (and instance if needed) that you configure or one that is automatically generated for you. Changes made to the environment values for LocalServiceTestHelper after you call setUp() do not apply for ModulesService during your test run. For simple configurations LocalModulesServiceTestConfig will generate a configuration based on the current ApiProxy.Environment. The generated LocalModulesServiceTestConfig contains the following elements:

  1. If the envModuleId element is not "default" then an automatic scaling module version will be added with module = "default" and version = "1". This simulates the appengine rule that an application must have a version of the default module.
  2. If the envInstance has not been set or is set to its default "-1" value then an automatic scaling module version will be added with module = envModuleId and version = envVerionId. Note here and below that in the event envVersionId contains a .invalid input: '<'minor-version> suffix (eg "v1.9") the minor suffix is not included in the added module version.
  3. If the envInstance has been set or is set to a non default ("-1") value then a manual scaling module version will be added with module = envModuleId and version = envVerionId and instance = envInstance.
To configure a test to use ModulesService with a generated configuration perform these steps in the order given.
  1. Construct a LocalModulesServiceTestConfig
  2. Pass the LocalModulesServiceTestConfig to the LocalServiceTestHelper constructor with other needed LocalServiceTestConfig objects.
  3. Update the test ApiProxy.Environment to refer to a desired module, version and instance (if needed).
  4. Start the testing environment with setUp() and execute your test.
Here is a sample usage: 

   LocalServiceTestHelper helper;
   @Before
   public void createService() {
     helper = new LocalServiceTestHelper(new LocalModulesServiceTestConfig());
     helper.setEnvModuleId("m1");   // Optional
     helper.setEnvVersionId("v2");  // Optional
     helper.setEnvInstance("2");    // Optional
     helper.setUp();
   }
A tester may specify the module versions in the test configuration explicitly by following these steps.
  1. Construct a LocalModulesServiceTestConfig
  2. Add needed module versions with addDefaultModuleVersion(), addAutomaticScalingModuleVersion(java.lang.String, java.lang.String), addManualScalingModuleVersion(java.lang.String, java.lang.String, int) and addBasicScalingModuleVersion(java.lang.String, java.lang.String, int). When multiple versions are added for the same module, the first will be the default.
  3. Pass the LocalModulesServiceTestConfig to the LocalServiceTestHelper constructor with other needed LocalServiceTestConfig objects.
  4. Update the test ApiProxy.Environment to refer to a configured module instance as needed.
  5. Start the testing environment with setUp(). Changes made to the configuration after calling setUp() are not available during your test.

Here is a sample usage: 


   LocalServiceTestHelper helper;
   @Before
   public void createService() {
     helper = new LocalServiceTestHelper(new LocalModulesServiceTestConfig()
        .addDefaultModuleVersion()
        .addAutomaticScalingModuleVersion("a1", "v1") // default version for module "a1"
        .addManualScalingModuleVersion("m1", "v1", 2) // default version for module "m1"
        .addManualScalingModuleVersion("m1", "v2", 3));
     helper.setEnvModuleId("m1");
     helper.setEnvVersionId("v2");
     helper.setEnvInstance("0");  // Optional
     helper.setUp();
   }