AuthenticatedTest.java

/*
 * Copyright 2014 Google Inc. All rights reserved.
 *
 *
 * 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.google.maps;

import org.junit.Ignore;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

import java.util.ArrayList;
import java.util.Collection;

/**
 * Base class for tests requiring automated authentication.
 *
 * <p>Sub-classes need to implement a 1-arg constructor that takes a GeoApiContext that will be
 * supplied with an appropriate API key or client ID and secret set. The {@code RunWith
 * (Paramaterized.class)} annotation will then ensure that each test that inherits will be run
 * for each context returned from {@link #contexts()}. That is,
 * if an API_KEY and CLIENT_ID+CLIENT_SECRET are found, each test will be run twice and supplied
 * a context with the appropriate authentication tokens set.
 */
@RunWith(Parameterized.class) @Ignore
public class AuthenticatedTest {
  @Parameters
  public static Collection<Object[]> contexts() {
    Collection<Object[]> contexts = new ArrayList<Object[]>();

    // Travis can't run authorized tests from pull requests.
    // http://docs.travis-ci.com/user/pull-requests/#Security-Restrictions-when-testing-Pull-Requests
    if (System.getenv("TRAVIS_PULL_REQUEST") != null
        && !"false".equals(System.getenv("TRAVIS_PULL_REQUEST"))) {
      return contexts;
    }

   if (System.getenv("API_KEY") != null) {
      GeoApiContext context = new GeoApiContext()
          .setApiKey(System.getenv("API_KEY"));
      contexts.add(new Object[]{context});
    }

    if (!(System.getenv("CLIENT_ID") == null || System.getenv("CLIENT_SECRET") == null)) {
      GeoApiContext context = new GeoApiContext()
          .setEnterpriseCredentials(System.getenv("CLIENT_ID"), System.getenv("CLIENT_SECRET"));
      contexts.add(new Object[]{context});
    }

    if (contexts.size() == 0) {
      throw new IllegalArgumentException("No credentials found! Set the API_KEY or CLIENT_ID and "
          + "CLIENT_SECRET environment variables to run tests requiring authentication.");
    }

    return contexts;
  }

  protected AuthenticatedTest() {
  }
}