SCM-Manager/scm-webapp/src/test/java/sonia/scm/it/IntegrationTestUtil.java

/**
 * Copyright (c) 2010, Sebastian Sdorra
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of SCM-Manager; nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */



package sonia.scm.it;

//~--- non-JDK imports --------------------------------------------------------

import sonia.scm.ScmState;
import sonia.scm.Type;
import sonia.scm.repository.client.RepositoryClient;
import sonia.scm.repository.client.RepositoryClientException;
import sonia.scm.user.User;
import sonia.scm.util.IOUtil;

import static org.junit.Assert.*;

//~--- JDK imports ------------------------------------------------------------

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.client.apache.ApacheHttpClient;
import com.sun.jersey.client.apache.config.ApacheHttpClientConfig;
import com.sun.jersey.client.apache.config.DefaultApacheHttpClientConfig;
import com.sun.jersey.core.util.MultivaluedMapImpl;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;

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

import javax.ws.rs.core.MultivaluedMap;

/**
 *
 * @author Sebastian Sdorra
 */
public final class IntegrationTestUtil
{

  /** Field description */
  public static final String ADMIN_PASSWORD = "scmadmin";

  /** Field description */
  public static final String ADMIN_USERNAME = "scmadmin";

  public static final String URL = "http://localhost:8081/scm";
  
  /** Field description */
  public static final String BASE_URL = "http://localhost:8081/scm/api/rest/";

  /** Field description */
  public static final String EXTENSION = ".xml";

  //~--- constructors ---------------------------------------------------------

  /**
   * Constructs ...
   *
   */
  private IntegrationTestUtil() {}

  //~--- methods --------------------------------------------------------------

  /**
   * Method description
   *
   *
   * @param client
   * @param username
   * @param password
   *
   * @return
   */
  public static ClientResponse authenticate(Client client, String username,
    String password)
  {
    WebResource wr = createResource(client, "authentication/login");
    MultivaluedMap<String, String> formData = new MultivaluedMapImpl();

    formData.add("username", username);
    formData.add("password", password);

    return wr.type("application/x-www-form-urlencoded").post(
      ClientResponse.class, formData);
  }

  /**
   * Method description
   *
   *
   * @param client
   *
   * @return
   */
  public static ScmState authenticateAdmin(Client client)
  {
    ClientResponse cr = authenticate(client, ADMIN_USERNAME, ADMIN_PASSWORD);
    ScmState state = cr.getEntity(ScmState.class);

    cr.close();
    assertNotNull(state);
    assertTrue(state.isSuccess());

    User user = state.getUser();

    assertNotNull(user);
    assertEquals("scmadmin", user.getName());
    assertTrue(user.isAdmin());

    Collection<Type> types = state.getRepositoryTypes();

    assertNotNull(types);
    assertFalse(types.isEmpty());

    return state;
  }

  /**
   * Method description
   *
   *
   * @return
   */
  public static Client createAdminClient()
  {
    Client client = createClient();

    authenticateAdmin(client);

    return client;
  }

  /**
   * Method description
   *
   *
   * @return
   */
  public static Client createClient()
  {
    DefaultApacheHttpClientConfig config = new DefaultApacheHttpClientConfig();

    config.getProperties().put(ApacheHttpClientConfig.PROPERTY_HANDLE_COOKIES,
      true);

    return ApacheHttpClient.create(config);
  }

  /**
   * Method description
   *
   *
   *
   * @param client
   *
   * @throws IOException
   * @throws RepositoryClientException
   */
  public static void createRandomFile(RepositoryClient client)
    throws IOException, RepositoryClientException
  {
    String uuid = UUID.randomUUID().toString();
    String name = "file-" + uuid + ".uuid";
    FileOutputStream out = null;

    try
    {
      out = new FileOutputStream(new File(client.getLocalRepository(), name));
      out.write(uuid.getBytes());
    }
    finally
    {
      IOUtil.close(out);
    }

    client.add(name);
  }

  /**
   * Method description
   *
   *
   * @return
   */
  public static Collection<String[]> createRepositoryTypeParameters()
  {
    Collection<String[]> params = new ArrayList<String[]>();

    params.add(new String[] { "git" });
    params.add(new String[] { "svn" });

    if (IOUtil.search("hg") != null)
    {
      params.add(new String[] { "hg" });
    }

    return params;
  }

  /**
   * Method description
   *
   *
   * @param client
   * @param url
   *
   * @return
   */
  public static WebResource createResource(Client client, String url)
  {
    return client.resource(createResourceUrl(url));
  }

  /**
   * Method description
   *
   *
   * @param url
   *
   * @return
   */
  public static String createResourceUrl(String url)
  {
    return BASE_URL.concat(url).concat(EXTENSION);
  }

  /**
   * Method description
   *
   *
   * @return
   */
  public static File createTempDirectory()
  {
    File directory = new File(System.getProperty("java.io.tmpdir"),
                       UUID.randomUUID().toString());

    IOUtil.mkdirs(directory);

    return directory;
  }

  /**
   * Method description
   *
   *
   * @param client
   */
  public static void logoutClient(Client client)
  {
    WebResource wr = createResource(client, "authentication/logout");
    ClientResponse response = wr.get(ClientResponse.class);

    assertNotNull(response);
    assertEquals(200, response.getStatus());
    response.close();
    client.destroy();
  }
}