UsersSettingsEndpointTest.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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 org.opencastproject.adminui.endpoint;

import static com.jayway.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasSize;
import static org.opencastproject.rest.RestServiceTestEnv.localhostRandomPort;
import static org.opencastproject.rest.RestServiceTestEnv.testEnvForClasses;

import org.opencastproject.rest.RestServiceTestEnv;

import com.jayway.restassured.http.ContentType;

import org.apache.http.HttpStatus;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Set;

public class UsersSettingsEndpointTest {
  private static final Logger logger = LoggerFactory.getLogger(UsersSettingsEndpointTest.class);
  private static final RestServiceTestEnv rt = testEnvForClasses(localhostRandomPort(), TestUserSettingsEndpoint.class);

  private JSONParser parser;

  private void compareIds(String key, JSONObject expected, JSONObject actual) {
    JSONArray expectedArray = (JSONArray) expected.get(key);
    JSONArray actualArray = (JSONArray) actual.get(key);

    Assert.assertEquals(expectedArray.size(), actualArray.size());
    JSONObject exObject;
    JSONObject acObject;
    int actualId;
    for (int i = 0; i < actualArray.size(); i++) {
      acObject = (JSONObject) actualArray.get(i);
      actualId = Integer.parseInt(acObject.get("id").toString()) - 1;
      exObject = (JSONObject) expectedArray.get(actualId);
      Set<String> exEntrySet = exObject.keySet();
      Assert.assertEquals(exEntrySet.size(), acObject.size());
      Iterator<String> exIter = exEntrySet.iterator();

      while (exIter.hasNext()) {
        String item = exIter.next();
        Object exValue = exObject.get(item);
        Object acValue = acObject.get(item);
        Assert.assertEquals(exValue, acValue);
      }

    }
  }

  @Test
  public void testGetUserSettingsInputsDefaultsExpectsDefaultLimitsAndOffsets() throws ParseException, IOException {
    InputStream stream = UsersSettingsEndpointTest.class.getResourceAsStream("/usersettings.json");
    InputStreamReader reader = new InputStreamReader(stream);
    JSONObject expected = (JSONObject) new JSONParser().parse(reader);
    JSONObject actual = (JSONObject) parser.parse(given().log().all().expect().statusCode(HttpStatus.SC_OK)
            .contentType(ContentType.JSON).body("total", equalTo(10)).body("offset", equalTo(0))
            .body("limit", equalTo(100)).body("results", hasSize(10)).when().get(rt.host("/settings.json")).asString());

    logger.info(actual.toJSONString());
    compareIds("results", expected, actual);
  }

  @Test
  public void testGetUserSettingsInputsNormalLimitsAndOffsetsExpectsDefaultLimitsAndOffsets() throws ParseException,
          IOException {
    InputStream stream = UsersSettingsEndpointTest.class.getResourceAsStream("/usersettings.json");
    InputStreamReader reader = new InputStreamReader(stream);
    JSONObject expected = (JSONObject) new JSONParser().parse(reader);

    JSONObject actual = (JSONObject) parser.parse(given().log().all().expect().statusCode(HttpStatus.SC_OK)
            .contentType(ContentType.JSON).body("total", equalTo(10)).body("offset", equalTo(0))
            .body("limit", equalTo(100)).body("results", hasSize(10)).when()
            .get(rt.host("/settings.json?limit=100&offset=0")).asString());

    logger.info(actual.toJSONString());
    compareIds("results", expected, actual);
  }

  @Ignore
  @Test
  public void testGetSignatureExpectsOK() throws ParseException, IOException {
    JSONObject actual = (JSONObject) parser.parse(given().log().all().expect().statusCode(HttpStatus.SC_OK)
            .contentType(ContentType.JSON).when().get(rt.host("/signature")).asString());
    logger.info(actual.toJSONString());
  }

  // FIXME
  @Ignore
  @SuppressWarnings("unchecked")
  @Test
  public void testPostSignatureExpectsOK() throws ParseException, IOException {
    String nameKey = "name";
    String nameValue = "newsignature";
    String fromNameKey = "from_name";
    String fromNameValue = "FakeName";
    String fromAddressKey = "from_address";
    String fromAddressValue = "from@fake.com";
    String textKey = "text";
    String textValue = "ThisIstheSignatureText";
    HashMap<String, String> parameters = new HashMap<String, String>();
    parameters.put(nameKey, nameValue);
    parameters.put(fromNameKey, fromNameValue);
    parameters.put(fromAddressKey, fromAddressValue);
    parameters.put(textKey, textValue);

    JSONObject creator = new JSONObject();
    creator.put("username", TestUserSettingsEndpoint.EXAMPLE_USERNAME);
    creator.put("email", TestUserSettingsEndpoint.EXAMPLE_EMAIL);
    creator.put("name", TestUserSettingsEndpoint.EXAMPLE_NAME);

    JSONObject actual = (JSONObject) parser.parse(given().formParam(nameKey, nameValue)
            .formParam(fromNameKey, fromNameValue).formParam(fromAddressKey, fromAddressValue)
            .formParam(textKey, textValue).log().all().expect().statusCode(HttpStatus.SC_OK)
            .contentType(ContentType.JSON).body(nameKey, equalTo(nameValue)).body("creator", equalTo(creator))
            .body("signature", equalTo(textValue)).when().post(rt.host("/signature")).asString());
    logger.info(actual.toJSONString());
  }

  @Test
  public void testPostSettingExpectsOK() throws ParseException, IOException {
    String key = "example_key";
    String value = "example_value";

    JSONObject actual = (JSONObject) parser.parse(given().formParam("key", key).formParam("value", value).log().all()
            .expect().statusCode(HttpStatus.SC_OK).contentType(ContentType.JSON).body("key", equalTo(key))
            .body("value", equalTo(value)).when().post(rt.host("setting")).asString());
    logger.info(actual.toJSONString());
  }

  @Ignore
  @Test
  public void testDeleteSignatureExpectsOK() throws ParseException, IOException {
    given().log().all().expect().statusCode(HttpStatus.SC_OK).when().delete(rt.host("/signature/19"));
  }

  @Test
  public void testDeleteUserSettingExpectsOK() throws ParseException, IOException {
    given().log().all().expect().statusCode(HttpStatus.SC_OK).when().delete(rt.host("/setting/18"));
  }

  // FIXME
  @Ignore
  @SuppressWarnings("unchecked")
  @Test
  public void testPutSignatureExpectsOK() throws ParseException, IOException {
    String nameKey = "name";
    String nameValue = "newsignature";
    String fromNameKey = "from_name";
    String fromAddressKey = "from_address";
    String textKey = "text";
    String textValue = "ThisIstheSignatureText";

    JSONObject creator = new JSONObject();
    creator.put("username", TestUserSettingsEndpoint.EXAMPLE_USERNAME);
    creator.put("email", TestUserSettingsEndpoint.EXAMPLE_EMAIL);
    creator.put("name", TestUserSettingsEndpoint.EXAMPLE_NAME);

    given().formParam(nameKey, nameValue).formParam(fromNameKey, TestUserSettingsEndpoint.EXAMPLE_NAME)
            .formParam(fromAddressKey, TestUserSettingsEndpoint.EXAMPLE_EMAIL).formParam(textKey, textValue).log()
            .all().expect().statusCode(HttpStatus.SC_OK).contentType(ContentType.JSON)
            .body(nameKey, equalTo(nameValue)).body("creator", equalTo(creator)).body("signature", equalTo(textValue))
            .when().put(rt.host("/signature/19")).asString();
  }

  @Test
  public void testPutSettingExpectsOK() throws ParseException, IOException {
    String key = TestUserSettingsEndpoint.EXAMPLE_KEY;
    String value = TestUserSettingsEndpoint.EXAMPLE_VALUE;

    given().pathParam("settingId", Long.toString(18)).formParam("key", key).formParam("value", value).log().all()
            .expect().statusCode(HttpStatus.SC_OK).contentType(ContentType.JSON).body("key", equalTo(key))
            .body("value", equalTo(value)).when().put(rt.host("/setting/{settingId}")).asString();
  }

  @Before
  public void setUp() {
    parser = new JSONParser();
  }

  @BeforeClass
  public static void oneTimeSetUp() {
    rt.setUpServer();
  }

  @AfterClass
  public static void oneTimeTearDown() {
    rt.tearDownServer();
  }

}