Updates to REST API - formatting, additional assertions, fix suite

2025-10-01 14:41:19 +00:00 · 2016-08-31 12:03:37 +03:00
parent 5cccdaf80b
commit da16d2c241
5 changed files with 56 additions and 73 deletions
--- a/e2e-test/java/org/alfresco/rest/RestDemoTest.java
+++ b/e2e-test/java/org/alfresco/rest/RestDemoTest.java
@@ -78,8 +78,11 @@ public class RestDemoTest extends RestTest
        				.assertThatCommentWithContentExists("This is a new comment");

        // update comment
-        commentEntry = commentsAPI.updateComment(document.getId(), commentEntry.getId(), "This is the updated comment");
-        commentsAPI.getNodeComments(document.getId()).assertThatResponseIsNotEmpty()
+        commentEntry = commentsAPI.updateComment(document.getId(), 
+                                                    commentEntry.getId(), 
+                                                    "This is the updated comment");
+        commentsAPI.getNodeComments(document.getId())
+                        .assertThatResponseIsNotEmpty()
                        .assertThatCommentWithIdExists(commentEntry.getId())
                        .assertThatCommentWithContentExists("This is the updated comment");
    }
@@ -101,19 +104,22 @@ public class RestDemoTest extends RestTest

        // add user as Consumer to site
        sitesApi.addPerson(siteModel.getId(), siteMember);
-        sitesApi.getSiteMembers(siteModel.getId()).assertThatSiteHasMember(siteMember.getId())
-                .getSiteMember(siteMember.getId()).assertSiteMemberHasRole(Role.SiteConsumer);
+        sitesApi.getSiteMembers(siteModel.getId())
+                                    .assertThatSiteHasMember(siteMember.getId())
+                                    .getSiteMember(siteMember.getId())
+                                    .assertSiteMemberHasRole(Role.SiteConsumer);

        // update site member to Manager
        siteMember.setRole(Role.SiteManager.toString());
        ;
        sitesApi.updateSiteMember(siteModel.getId(), newUser.getUsername(), siteMember);
-        sitesApi.getSiteMembers(siteModel.getId()).assertThatSiteHasMember(siteMember.getId())
-                .getSiteMember(siteMember.getId()).assertSiteMemberHasRole(Role.SiteManager);
+        sitesApi.getSiteMembers(siteModel.getId())
+                                    .assertThatSiteHasMember(siteMember.getId())
+                                    .getSiteMember(siteMember.getId())
+                                    .assertSiteMemberHasRole(Role.SiteManager);

        // delete site member
        sitesApi.deleteSiteMember(siteModel.getId(), newUser.getUsername());
        sitesApi.usingRestWrapper().assertStatusCodeIs(HttpStatus.NO_CONTENT.toString());
-
    }
 }
--- a/e2e-test/java/org/alfresco/rest/SampleCommentsTest.java
+++ b/e2e-test/java/org/alfresco/rest/SampleCommentsTest.java
@@ -1,10 +1,6 @@
 package org.alfresco.rest;

-import java.io.File;
-
 import org.alfresco.dataprep.CMISUtil.DocumentType;
-import org.alfresco.dataprep.ContentService;
-import org.alfresco.rest.RestCommentsApi;
 import org.alfresco.rest.exception.JsonToModelConversionException;
 import org.alfresco.rest.model.RestCommentModel;
 import org.alfresco.utility.data.DataUser;
@@ -13,7 +9,6 @@ import org.alfresco.utility.model.UserModel;
 import org.apache.chemistry.opencmis.client.api.Document;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
-import org.testng.Assert;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;

@@ -22,16 +17,11 @@ public class SampleCommentsTest extends RestTest
    @Autowired
    DataUser dataUser;

-    @Autowired
-    ContentService content;
-
    @Autowired
    RestCommentsApi commentsAPI;

    private UserModel userModel;
-    private File file;
    private Document document;
-    private String documentName = "textDocument-" + System.currentTimeMillis();

    @BeforeClass
    public void initTest() throws DataPreparationException
@@ -40,24 +30,25 @@ public class SampleCommentsTest extends RestTest
        restClient.authenticateUser(userModel);
        commentsAPI.useRestClient(restClient);

-        file = new File(documentName);
-        document = content.createDocumentInRepository(userModel.getUsername(), userModel.getPassword(), "Shared", DocumentType.TEXT_PLAIN, file,
-                "shared document content");
+        document = dataContent.usingPath("Shared")
+                              .usingUser(userModel)
+                              .createDocument(DocumentType.TEXT_PLAIN);
    }

    @Test
    public void addComments() throws JsonToModelConversionException
    {
        commentsAPI.addComment(document.getId(), "This is a new comment");
-        Assert.assertEquals(commentsAPI.usingRestWrapper().getStatusCode(), HttpStatus.CREATED.toString(), "Add comments response status code is not correct");
-
+        commentsAPI.usingRestWrapper()
+                   .assertStatusCodeIs(HttpStatus.CREATED.toString());
    }

    @Test
    public void getCommentsCheckStatusCode() throws JsonToModelConversionException
    {
        commentsAPI.getNodeComments(document.getId());
-        Assert.assertEquals(commentsAPI.usingRestWrapper().getStatusCode(), HttpStatus.OK.toString(), "Get comments response status code is not correct");
+        commentsAPI.usingRestWrapper()
+                   .assertStatusCodeIs(HttpStatus.OK.toString());
    }

    @Test
@@ -68,7 +59,7 @@ public class SampleCommentsTest extends RestTest

        // update comment
        RestCommentModel commentEntry = commentsAPI.updateComment(document.getId(), commentId, "This is the updated comment");
-        Assert.assertEquals(commentEntry.getContent(), "This is the updated comment", "New comment was not updated");
+        commentEntry.assertCommentContentIs("This is the updated comment");
    }

 }
--- a/e2e-test/java/org/alfresco/rest/SamplePeopleTest.java
+++ b/e2e-test/java/org/alfresco/rest/SamplePeopleTest.java
@@ -8,7 +8,6 @@ import org.alfresco.utility.model.UserModel;
 import org.apache.commons.lang3.RandomStringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
-import org.testng.Assert;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;

@@ -31,36 +30,20 @@ public class SamplePeopleTest extends RestTest
    }

    @Test
-    public void getPerson() throws JsonToModelConversionException
+    public void getPersonCheckResponseAndStatus() throws JsonToModelConversionException
    {
-        Assert.assertNotNull(peopleAPI.getPerson(userModel.getUsername()), "Get person response should not be null");
-        Assert.assertEquals(peopleAPI.usingRestWrapper().getStatusCode(), HttpStatus.OK.toString(), "Get person response status code is not correct");
-    }
+        peopleAPI.getPerson(userModel.getUsername())
+                    .assertResponseIsNotEmpty();        
        
-    @Test
-    public void getPersonResponseNotNull() throws JsonToModelConversionException
-    {
-        Assert.assertNotNull(peopleAPI.getPerson(userModel.getUsername()), "Get person response should not be null");
-    }
-
-    @Test
-    public void getPersonCheckStatusCode() throws JsonToModelConversionException
-    {
-        peopleAPI.getPerson(userModel.getUsername());
-        Assert.assertEquals(peopleAPI.usingRestWrapper().getStatusCode(), HttpStatus.OK.toString(), "Get person response status code is not correct");
-    }
-
-    @Test
-    public void getPersonResponseNotNull1() throws JsonToModelConversionException
-    {
-        Assert.assertNotNull(peopleAPI.getPerson(userModel.getUsername()), "Get person response should not be null");
+        peopleAPI.usingRestWrapper()
+                    .assertStatusCodeIs(HttpStatus.OK.toString());
    }

    @Test
    public void getPersonCheckStatusCode1() throws JsonToModelConversionException
    {
-        peopleAPI.getPerson(userModel.getUsername());
-        Assert.assertEquals(peopleAPI.usingRestWrapper().getStatusCode(), HttpStatus.OK.toString(), "Get person response status code is not correct");
+        peopleAPI.getPerson(userModel.getUsername())
+                    .assertPersonHasName(userModel.getUsername());
    }

 }
--- a/e2e-test/java/org/alfresco/rest/SampleSitesTest.java
+++ b/e2e-test/java/org/alfresco/rest/SampleSitesTest.java
@@ -1,7 +1,5 @@
 package org.alfresco.rest;

-import org.alfresco.dataprep.ContentService;
-import org.alfresco.rest.RestSitesApi;
 import org.alfresco.rest.exception.JsonToModelConversionException;
 import org.alfresco.rest.model.SiteMember;
 import org.alfresco.utility.data.DataSite;
@@ -12,7 +10,6 @@ import org.alfresco.utility.model.UserModel;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.social.alfresco.api.entities.Role;
-import org.testng.Assert;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;

@@ -27,9 +24,6 @@ public class SampleSitesTest extends RestTest
    @Autowired
    DataSite dataSite;

-    @Autowired
-    ContentService content;
-
    private UserModel userModel;
    private SiteModel siteModel;

@@ -45,56 +39,65 @@ public class SampleSitesTest extends RestTest
    @Test
    public void getSiteResponseNotNull() throws JsonToModelConversionException
    {
-        Assert.assertNotNull(siteAPI.getSite(siteModel.getId()), "Get site response should not be null");
+        siteAPI.getSite(siteModel.getId()).assertResponseIsNotEmpty();
    }

    @Test
    public void getSiteCheckStatusCode() throws JsonToModelConversionException
    {
        siteAPI.getSite(siteModel.getId());
-        Assert.assertEquals(siteAPI.usingRestWrapper().getStatusCode(), HttpStatus.OK.toString(), "Get site response status code is not correct");
+        siteAPI.usingRestWrapper()
+                .assertStatusCodeIs(HttpStatus.OK.toString());
    }

    @Test
-    public void getSitesResponseNotNull() throws JsonToModelConversionException
+    public void getSitesResponseNotEmpty() throws JsonToModelConversionException
    {
-        Assert.assertNotNull(siteAPI.getSites().getEntries(), "Get sites response should not be null");
+        siteAPI.getSites()
+                .assertThatResponseIsNotEmpty();
    }

    @Test
    public void getSitesCheckStatusCode() throws JsonToModelConversionException
    {
        siteAPI.getSites();
-        Assert.assertEquals(siteAPI.usingRestWrapper().getStatusCode(), HttpStatus.OK.toString(), "Get sites response status code is not correct");
+        siteAPI.usingRestWrapper()
+                .assertStatusCodeIs(HttpStatus.OK.toString());
    }

    @Test
    public void sitesCollectionHasPagination() throws JsonToModelConversionException
    {
        siteAPI.getSites().assertResponseHasPagination();
-        Assert.assertEquals(siteAPI.getSites().getPagination().getCount(), 100, "Sites collection should have pagination");
    }

    @Test
    public void addMemberToSiteCheckStatusCode() throws JsonToModelConversionException, DataPreparationException
    {
        UserModel newMember = dataUser.createRandomTestUser();
-        SiteMember siteMember = new SiteMember(Role.SiteCollaborator.toString(), newMember.getUsername());
+        SiteMember siteMember = new SiteMember(Role.SiteCollaborator.toString(), 
+                                    newMember.getUsername());
+        
        siteAPI.addPerson(siteModel.getId(), siteMember);
-        Assert.assertEquals(siteAPI.usingRestWrapper().getStatusCode(), HttpStatus.CREATED.toString(),
-                "Add member to site response status code is not correct");
+        siteAPI.usingRestWrapper()
+                .assertStatusCodeIs(HttpStatus.CREATED.toString());
    }

    @Test
    public void isSiteReturned() throws JsonToModelConversionException
    {
-        siteAPI.getAllSites().assertThatResponseHasSite(siteModel.getId());
+        siteAPI.getAllSites()
+                .assertThatResponseHasSite(siteModel.getId());
    }

    @Test
    public void checkSiteDetails() throws JsonToModelConversionException
    {
-        siteAPI.getSite(siteModel.getId());
+        siteAPI.getSite(siteModel.getId())
+                .assertResponseIsNotEmpty()
+                .assertSiteHasDescription(siteModel.getDescription())
+                .assertSiteHasTitle(siteModel.getTitle())
+                .assertSiteHasVisibility(siteModel.getVisibility());
    }

 }
--- a/e2e-test/resources/smoke-rest.xml
+++ b/e2e-test/resources/smoke-rest.xml
@@ -6,9 +6,9 @@
 	</listeners>
 	<test name="Test">
 		<classes>
-			<class name="org.alfresco.rest.v1.SamplePeopleTest"></class>
-			<class name="org.alfresco.rest.v1.SampleSitesTest"></class>
-			<class name="org.alfresco.rest.v1.SampleCommentsTest"></class>
+			<class name="org.alfresco.rest.SamplePeopleTest"></class>
+			<class name="org.alfresco.rest.SampleSitesTest"></class>
+			<class name="org.alfresco.rest.SampleCommentsTest"></class>
 		</classes>

 	</test> <!-- Test -->