taskqueue_test_util.py

#!/usr/bin/python2.4
#
# Copyright 2009 Google Inc.
#
# 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.

"""Utilities for writing unit tests that involve the AppEngine Task Queue API.

Based on code from the following post on gist.github, which demonstrate a set
of base classes that are designed to support the various AppEngine components:

https://gist.github.com/186251/6f1434f1ea0ccf5f618cbf3ac91b8dde07156977
"""

__author__ = 'Matthew.H.Frantz@gmail.com (Matt Frantz)'

try:
  from google3.apphosting.api.taskqueue import taskqueue_stub
  from google3.dotorg.gongo.appengine_cap2kml import appengine_test_util
except ImportError, e:
  import appengine_test_util
  from google.appengine.api.labs import taskqueue_stub


class TaskQueueTestBase(appengine_test_util.AppEngineTestBase):
  """Base class that allows unit tests to use the Task Queue API."""

  # If the subclass specifies this, it should point to the directory
  # containing queue.yaml.
  QUEUE_YAML_ROOT_PATH = None

  def setUp(self):
    super(TaskQueueTestBase, self).setUp()
    self.task_stub = taskqueue_stub.TaskQueueServiceStub(
        root_path=self.QUEUE_YAML_ROOT_PATH)
    self.apiproxy_stub_map.RegisterStub('taskqueue', self.task_stub)