Merge branch 'master' of archives.plil.fr:GIS2A4-Java/spring-persistence

Conflicts: src/main/java/fr/plil/sio/persistence/jdbc/RightServiceJdbc.java src/test/resources/application.properties

Merge branch 'master' of archives.plil.fr:GIS2A4-Java/spring-persistence
Conflicts: src/main/java/fr/plil/sio/persistence/jdbc/RightServiceJdbc.java src/test/resources/application.properties
Mohammed-Zakaria Sahmane
2 parents 3de62e47 b6a31a21
Showing 12 changed files with 51 additions and 28 deletions Show diff stats
.gitignore
pom.xml
src/main/java/fr/plil/sio/persistence/jdbc/JdbcApplication.java -> src/main/java/fr/plil/sio/persistence/JdbcApplication.java
src/main/java/fr/plil/sio/persistence/api/Group.java
src/main/java/fr/plil/sio/persistence/api/GroupService.java
src/main/java/fr/plil/sio/persistence/api/Right.java
src/main/java/fr/plil/sio/persistence/api/RightService.java
src/main/java/fr/plil/sio/persistence/api/User.java
src/main/java/fr/plil/sio/persistence/jdbc/RightServiceJdbc.java
src/test/java/fr/plil/sio/persistence/jdbc/GroupServiceTest.java
src/test/java/fr/plil/sio/persistence/jdbc/RightServiceTest.java
src/test/java/fr/plil/sio/persistence/jdbc/UserServiceTest.java
 *.iml
-*/target/
+target/
 .idea/
 */.idea/
 /target/
 \ No newline at end of file
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                              http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
@@ -11,7 +11,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>1.3.6.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
     </parent>
     <dependencies>
@@ -22,6 +22,7 @@
         <dependency>
             <groupId>com.h2database</groupId>
             <artifactId>h2</artifactId>
+            <scope>runtime</scope>
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
-package fr.plil.sio.persistence.jdbc;
+package fr.plil.sio.persistence;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -2,9 +2,11 @@ package fr.plil.sio.persistence.api;
 import java.util.LinkedList;
 import java.util.List;
-import java.util.Set;
-import java.util.TreeSet;
+/**
+ * A group is unique by its name (no two groups with the same name or the same ID can exist in the database).
+ * A group contains a list of rights unique by their ID (no two groups with the same ID can exist in the database).
+ */
 public class Group {
     private Long id;
@@ -14,7 +16,7 @@ public class Group {
     /**
      * Users in the group.
      */
-    private Set<User> users = new TreeSet<>();
+    private List<User> users = new LinkedList<>();
     /**
      * List of rights. The list CANNOT contains duplicate rights.
@@ -45,11 +47,11 @@ public class Group {
         this.name = name;
     }
-    public Set<User> getUsers() {
+    public List<User> getUsers() {
         return users;
     }
-    public void setUsers(Set<User> users) {
+    public void setUsers(List<User> users) {
         this.users = users;
     }
 }
@@ -4,7 +4,7 @@ public interface GroupService {
     /**
      * Create a group with a specific name in the database.
-     * There is no two groups with the same name in the database.
+     * There is no two groups with the same name or the same ID in the database.
      *
      * @param name the name of the group
      * @return an instance of the group
@@ -23,7 +23,8 @@ public interface GroupService {
     boolean delete(String name);
     /**
-     * Find a group in the database based on its name.
+     * Find a group in the database based on its name. Only references at one level are loaded (i.e. the users
+     * who belong to the group).
      *
      * @param name the name of the group to search for.
      * @return an instance of the group if found, else null.
@@ -32,7 +33,7 @@ public interface GroupService {
     Group findByName(String name);
     /**
-     * Add a right in the group. Right is inserted at the end of rights list of the group.
+     * Add a right in the group.
      *
      * @param groupName the name of the group.
      * @param right     the right to add
 package fr.plil.sio.persistence.api;
-import java.util.HashSet;
-import java.util.Set;
-
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * A right is unique by itd ID, i.e. it can exist two rights with the same name in the database.
+ * A right may have a parent, null else.
+ * A right can have zero, one or more siblings.
+ */
 public class Right {
     private Long id;
     private String name;
-    /// the parent group
+    /// the parent right
     private Right parent;
-    /// the sibling group(s), eventually empty
-    private Set<Right> siblings = new HashSet<>();
+    /// the sibling right(s), eventually empty
+    private List<Right> siblings = new LinkedList<>();
-    public Set<Right> getSiblings() {
+    public List<Right> getSiblings() {
         return siblings;
     }
-    public void setSiblings(Set<Right> siblings) {
+    public void setSiblings(List<Right> siblings) {
         this.siblings = siblings;
     }
@@ -16,6 +16,8 @@ public interface RightService {
     /**
      * Create a sibling right attached to a parent right with a specific name in the database.
      * It is possible that two rights has the same name.
+     * Return only the right with the parent in the field parent.
+     *
      *
      * @param name   the name of the right
      * @param parent the parent right
@@ -34,6 +36,7 @@ public interface RightService {
     /**
      * Find a list of rights in the database based on their name.
+     * All dependencies at one-level are loaded, i.e for each right returned the parent and sibling are present.
      *
      * @param name the name of the rights to search for.
      * @return A list of rights, eventually empty.
@@ -43,6 +46,7 @@ public interface RightService {
     /**
      * Find a right in the database based on its id.
+     * All dependencies at one-level are loaded, i.e the parent and sibling are present.
      *
      * @param id the name of the right to search for.
      * @return an instance of the right if found, else null.
 package fr.plil.sio.persistence.api;
+/**
+ * An user MUST have a group in the database.
+ * An user is unique by it name, i.e. database cannot contain two user with the same name or the same ID.
+ */
 public class User {
     private Long id;
@@ -44,7 +44,6 @@ public class RightServiceJdbc implements RightService {
         rightRepository.save(right);
         return right;
-        
     }
     @Override
@@ -5,7 +5,7 @@ import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.SpringApplicationConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 import static org.junit.Assert.*;
@@ -13,7 +13,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 @RunWith(SpringJUnit4ClassRunner.class)
-@SpringApplicationConfiguration(classes = JdbcApplication.class)
+@SpringBootTest
 public class GroupServiceTest extends AbstractServiceSupport {
     private static final Logger logger = LoggerFactory.getLogger(GroupServiceTest.class);
@@ -56,6 +56,7 @@ public class GroupServiceTest extends AbstractServiceSupport {
         groupService.create("group");
     }
+    @Test
     public void testDeleteGroup() {
         logger.info("testDeleteGroup");                
         assertTrue(groupService.delete("group"));
@@ -63,6 +64,7 @@ public class GroupServiceTest extends AbstractServiceSupport {
         assertFalse(groupService.delete("group"));
     }
+    @Test
     public void testDeleteNotExistingGroup() {
         logger.info("testDeleteNotExistingGroup");
         assertFalse(groupService.delete("not-a-group"));
@@ -5,13 +5,13 @@ import fr.plil.sio.persistence.api.RightService;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.SpringApplicationConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 import static org.junit.Assert.*;
 @RunWith(SpringJUnit4ClassRunner.class)
-@SpringApplicationConfiguration(classes = JdbcApplication.class)
+@SpringBootTest
 public class RightServiceTest extends AbstractServiceSupport {
     @Autowired
@@ -5,13 +5,13 @@ import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.SpringApplicationConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 import static org.junit.Assert.*;
 @RunWith(SpringJUnit4ClassRunner.class)
-@SpringApplicationConfiguration(classes = JdbcApplication.class)
+@SpringBootTest
 public class UserServiceTest extends AbstractServiceSupport {
     @Autowired
@@ -63,10 +63,12 @@ public class UserServiceTest extends AbstractServiceSupport {
         userService.create("user", "group");
     }
+    @Test
     public void testDeleteUser() {
         assertTrue(userService.delete("user"));
     }
+    @Test
     public void testDeleteUserIfNotFound() {
         assertFalse(userService.delete("user"));
     }
@@ -85,16 +87,19 @@ public class UserServiceTest extends AbstractServiceSupport {
         assertNull(userService.findByName(null));
     }
+    @Test
     public void testIsUserHasExactRight() {
         Right right = rightService.findByName("parent").get(0);
         assertTrue(userService.isUserHasRight("user", right));
     }
+    @Test
     public void testIsUserHasRightByParents() {
         Right right = rightService.findByName("sibling").get(0);
         assertTrue(userService.isUserHasRight("user", right));
     }
+    @Test
     public void testIsUserHasNotTheExactRight() {
         Right right = rightService.findByName("not-for-me").get(0);
         assertFalse(userService.isUserHasRight("user", right));