1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

/*
 * Copyright (c) 2009 Jens Scheffler (appenginefan.com)
 * 
 * Licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the
 * License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See
 * the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.appenginefan.toolkit.unittests;

import javax.jdo.PersistenceManager;

import com.google.apphosting.api.ApiProxy;

import junit.framework.TestCase;

/**
 * A simple test base class that can be extended to build
 * unit tests that properly construct and tear down App
 * Engine test environments.
 */
public abstract class BaseTest
    extends TestCase {

  private boolean wasSuccess;

  /**
   * The initializer used in this test.
   */
  protected TestInitializer initializer;

  /**
   * Returns the environment that should be used for the
   * unit tests, or null if the default should be used.
   */
  protected ApiProxy.Environment getEnvironmentOrNull() {
    return null;
  }

  /**
   * Sets up the App Engine environment.
   */
  @Override
  protected void setUp() throws Exception {
    if (initializer != null) {
      throw new UnsupportedOperationException(
          "setup may only be called once!");
    }
    super.setUp();
    initializer =
        new TestInitializer(getEnvironmentOrNull());
    initializer.setUp();
  }

  /**
   * Runs the test and remembers whether an exception was
   * thrown (needed for proper teardown of test)
   */
  @Override
  protected void runTest() throws Throwable {
    wasSuccess = false;
    super.runTest();
    wasSuccess = true;
  }

  /**
   * Deconstructs the App Engine environment.
   */
  @Override
  protected void tearDown() throws Exception {
    if (initializer == null) {
      throw new UnsupportedOperationException(
          "setup must be called before teardown");
    }
    super.tearDown();
    initializer.tearDown(wasSuccess);
  }

  /**
   * Convenience method: gets a new PersistenceManager
   */
  public PersistenceManager newPersistenceManager() {
    return initializer.getPersistenceManagerFactory()
        .getPersistenceManager();
  }

}