/**
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at the
* <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Initial code contributed and copyrighted by<br>
* frentix GmbH, http://www.frentix.com
* <p>
*/
package org.olat.restapi;
import static org.junit.Assert.assertEquals;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.List;
import java.util.UUID;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriBuilder;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.olat.core.commons.persistence.DB;
import org.olat.core.id.Identity;
import org.olat.core.id.OLATResourceable;
import org.olat.core.util.resource.OresHelper;
import org.olat.course.ICourse;
import org.olat.course.db.CourseDBEntry;
import org.olat.course.db.CourseDBManager;
import org.olat.repository.RepositoryEntry;
import org.olat.repository.RepositoryManager;
import org.olat.restapi.repository.course.CoursesWebService;
import org.olat.restapi.support.vo.KeyValuePair;
import org.olat.test.JunitTestHelper;
import org.olat.test.OlatJerseyTestCase;
import org.springframework.beans.factory.annotation.Autowired;
/**
*
* Initial date: 03.03.2014<br>
* @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
*
*/
public class CourseDBTest extends OlatJerseyTestCase {
private Identity auth;
private ICourse course;
private boolean initialized = false;
@Autowired
private DB dbInstance;
@Autowired
private CourseDBManager courseDbManager;
@Autowired
private RepositoryManager repositoryManager;
@Before
public void setUp() throws Exception {
super.setUp();
// create course and persist as OLATResourceImpl
if(!initialized) {
auth = JunitTestHelper.createAndPersistIdentityAsUser("rest-course-cal-one");
course = CoursesWebService.createEmptyCourse(auth, "course calendar", "course with calendar for REST API testing", null);
initialized = true;
}
}
@Test
public void createEntry_putQuery() throws IOException, URISyntaxException {
RestConnection conn = new RestConnection();
Assert.assertTrue(conn.login(auth.getName(), JunitTestHelper.PWD));
String category = createRndCategory();
String key = "myKeyName";
String value = "an interessant value";
UriBuilder uri = getUriBuilder(course.getResourceableId(), category).path("values")
.path(key).queryParam("value", value);
HttpPut put = conn.createPut(uri.build(), MediaType.APPLICATION_JSON, true);
HttpResponse response = conn.execute(put);
assertEquals(200, response.getStatusLine().getStatusCode());
EntityUtils.consume(response.getEntity());
conn.shutdown();
CourseDBEntry entry = courseDbManager.getValue(course, auth, category, key);
Assert.assertNotNull(entry);
Assert.assertEquals(key, entry.getName());
Assert.assertEquals(value, entry.getValue());
Assert.assertEquals(category, entry.getCategory());
}
@Test
public void createEntry_putQuery_repoKey() throws IOException, URISyntaxException {
RestConnection conn = new RestConnection();
Assert.assertTrue(conn.login(auth.getName(), JunitTestHelper.PWD));
OLATResourceable courseOres = OresHelper.createOLATResourceableInstance("CourseModule", course.getResourceableId());
RepositoryEntry courseRe = repositoryManager.lookupRepositoryEntry(courseOres, true);
String category = createRndCategory();
String key = "myKeyName";
String value = "an interessant value";
UriBuilder uri = getUriBuilder(courseRe.getKey(), category).path("values")
.path(key).queryParam("value", value);
HttpPut put = conn.createPut(uri.build(), MediaType.APPLICATION_JSON, true);
HttpResponse response = conn.execute(put);
assertEquals(200, response.getStatusLine().getStatusCode());
EntityUtils.consume(response.getEntity());
conn.shutdown();
CourseDBEntry entry = courseDbManager.getValue(course, auth, category, key);
Assert.assertNotNull(entry);
Assert.assertEquals(key, entry.getName());
Assert.assertEquals(value, entry.getValue());
Assert.assertEquals(category, entry.getCategory());
}
@Test
public void createEntry_putJsonEntity() throws IOException, URISyntaxException {
RestConnection conn = new RestConnection();
Assert.assertTrue(conn.login(auth.getName(), JunitTestHelper.PWD));
String category = createRndCategory();
KeyValuePair keyValuePair = new KeyValuePair();
keyValuePair.setKey("firstKey");
keyValuePair.setValue("first value");
UriBuilder uri = getUriBuilder(course.getResourceableId(), category).path("values");
HttpPut put = conn.createPut(uri.build(), MediaType.APPLICATION_JSON, true);
conn.addJsonEntity(put, keyValuePair);
HttpResponse response = conn.execute(put);
assertEquals(200, response.getStatusLine().getStatusCode());
EntityUtils.consume(response.getEntity());
conn.shutdown();
}
@Test
public void createEntry_post() throws IOException, URISyntaxException {
RestConnection conn = new RestConnection();
Assert.assertTrue(conn.login(auth.getName(), JunitTestHelper.PWD));
String category = createRndCategory();
String key = "postit";
String value = "create the value by POST";
UriBuilder uri = getUriBuilder(course.getResourceableId(), category).path("values").path(key);
HttpPost put = conn.createPost(uri.build(), MediaType.APPLICATION_JSON);
conn.addEntity(put, new BasicNameValuePair("val", value));
HttpResponse response = conn.execute(put);
assertEquals(200, response.getStatusLine().getStatusCode());
EntityUtils.consume(response.getEntity());
conn.shutdown();
CourseDBEntry entry = courseDbManager.getValue(course, auth, category, key);
Assert.assertNotNull(entry);
Assert.assertEquals(key, entry.getName());
Assert.assertEquals(value, entry.getValue());
Assert.assertEquals(category, entry.getCategory());
}
@Test
public void createEntry_get() throws IOException, URISyntaxException {
String category = createRndCategory();
String key = "getit";
String value = "get a value";
CourseDBEntry entry = courseDbManager.setValue(course, auth, category, key, value);
dbInstance.commitAndCloseSession();
Assert.assertNotNull(entry);
RestConnection conn = new RestConnection();
Assert.assertTrue(conn.login(auth.getName(), JunitTestHelper.PWD));
UriBuilder uri = getUriBuilder(course.getResourceableId(), category).path("values").path(key);
HttpGet get = conn.createGet(uri.build(), MediaType.APPLICATION_JSON, true);
HttpResponse response = conn.execute(get);
assertEquals(200, response.getStatusLine().getStatusCode());
KeyValuePair savedEntry = conn.parse(response, KeyValuePair.class);
conn.shutdown();
Assert.assertNotNull(savedEntry);
Assert.assertEquals(key, savedEntry.getKey());
Assert.assertEquals(value, savedEntry.getValue());
}
@Test
public void getUsedCategories() throws IOException, URISyntaxException {
RestConnection conn = new RestConnection();
Assert.assertTrue(conn.login(auth.getName(), JunitTestHelper.PWD));
String category = createRndCategory();
KeyValuePair keyValuePair = new KeyValuePair();
keyValuePair.setKey("catKey");
keyValuePair.setValue("category value");
UriBuilder uri = getUriBuilder(course.getResourceableId(), category).path("values");
HttpPut put = conn.createPut(uri.build(), MediaType.APPLICATION_JSON, true);
conn.addJsonEntity(put, keyValuePair);
HttpResponse response = conn.execute(put);
assertEquals(200, response.getStatusLine().getStatusCode());
EntityUtils.consume(response.getEntity());
conn.shutdown();
List<String> categories = courseDbManager.getUsedCategories(course);
Assert.assertNotNull(categories);
Assert.assertTrue(categories.contains(category));
}
private String createRndCategory() {
return UUID.randomUUID().toString().replace("-", "").substring(0, 32);
}
private UriBuilder getUriBuilder(Long courseId, String category) {
return UriBuilder.fromUri(getContextURI()).path("repo").path("courses")
.path(courseId.toString()).path("db").path(category);
}
}