Feature/gap 1850 spadmin (#52)

feat (super admin dashboard): adds functionality for super admin dashboard

---------

Co-authored-by: john-tco <[email protected]>
Co-authored-by: Dylan Wright <[email protected]>
Co-authored-by: Dominic West <[email protected]>

pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<groupId>org.springframework.boot</groupId>
@@ -39,6 +39,19 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-security</artifactId>
 		</dependency>
+
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct</artifactId>
+			<version>1.5.2.Final</version>
+		</dependency>
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct-processor</artifactId>
+			<version>1.5.2.Final</version>
+		</dependency>
+
+
 		<dependency>
 			<groupId>org.springframework.security</groupId>
 			<artifactId>spring-security-core</artifactId>
@@ -181,9 +194,9 @@
 				<groupId>org.flywaydb</groupId>
 				<artifactId>flyway-maven-plugin</artifactId>
 				<configuration>
-					<url>jdbc:postgresql://localhost:5433/gapuserlocaldb</url>
-					<user>root</user>
-					<password>root</password>
+					<url>jdbc:postgresql://localhost:5432/gapuserlocaldb</url>
+					<user>postgres</user>
+					<password>postgres</password>
 					<cleanDisabled>false</cleanDisabled>
 				</configuration>
 			</plugin>
@@ -197,6 +210,39 @@
 				</configuration>
 			</plugin>
 
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.8.1</version>
+				<configuration>
+					<source>17</source>
+					<target>17</target>
+					<annotationProcessorPaths>
+						<path>
+							<groupId>org.mapstruct</groupId>
+							<artifactId>mapstruct-processor</artifactId>
+							<version>1.5.1.Final</version>
+						</path>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok</artifactId>
+							<version>1.18.24</version>
+						</path>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok-mapstruct-binding</artifactId>
+							<version>0.2.0</version>
+						</path>
+					</annotationProcessorPaths>
+				</configuration>
+			</plugin>
+
+
+
+
+
+
+
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-antrun-plugin</artifactId>
@@ -245,7 +291,7 @@
 					</execution>
 				</executions>
 			</plugin>
-        </plugins>
+		</plugins>
 	</build>
 
 </project>

src/main/java/gov/cabinetofice/gapuserservice/dto/ChangeDepartmentPageDto.java

@@ -0,0 +1,14 @@
+package gov.cabinetofice.gapuserservice.dto;
+
+import gov.cabinetofice.gapuserservice.model.User;
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+@Builder
+public class ChangeDepartmentPageDto {
+    private User user;
+    private List<DepartmentDto> departments;
+}

src/main/java/gov/cabinetofice/gapuserservice/dto/DepartmentDto.java

@@ -0,0 +1,12 @@
+package gov.cabinetofice.gapuserservice.dto;
+
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+@Builder
+public class DepartmentDto {
+    private String id;
+    private String name;
+    private String ggisID;
+}

src/main/java/gov/cabinetofice/gapuserservice/dto/OneLoginUserInfoDto.java

@@ -6,6 +6,6 @@
 @Data
 @Builder
 public class OneLoginUserInfoDto {
-    private String email;
+    private String emailAddress;
     private String sub;
 }

src/main/java/gov/cabinetofice/gapuserservice/dto/RoleDto.java

@@ -0,0 +1,12 @@
+package gov.cabinetofice.gapuserservice.dto;
+
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+@Builder
+public class RoleDto {
+    private String id;
+    private String name;
+    private String description;
+}

src/main/java/gov/cabinetofice/gapuserservice/dto/SuperAdminDashboardPageDto.java

@@ -0,0 +1,15 @@
+package gov.cabinetofice.gapuserservice.dto;
+
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+@Builder
+public class SuperAdminDashboardPageDto {
+    private List<RoleDto> roles;
+    private List<DepartmentDto> departments;
+    private List<UserDto> users;
+    private long userCount;
+}

src/main/java/gov/cabinetofice/gapuserservice/dto/UserDto.java

@@ -0,0 +1,17 @@
+package gov.cabinetofice.gapuserservice.dto;
+
+import gov.cabinetofice.gapuserservice.model.Department;
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Builder
+@Data
+public class UserDto {
+    private String gapUserId;
+    private String emailAddress;
+    private String sub;
+    private List<RoleDto> roles;
+    private Department department;
+}

src/main/java/gov/cabinetofice/gapuserservice/exceptions/DepartmentNotFoundException.java

@@ -0,0 +1,11 @@
+package gov.cabinetofice.gapuserservice.exceptions;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(HttpStatus.NOT_FOUND)
+public class DepartmentNotFoundException extends RuntimeException {
+    public DepartmentNotFoundException(String message) {
+        super(message);
+    }
+}

src/main/java/gov/cabinetofice/gapuserservice/exceptions/UserNotFoundException.java

@@ -1,5 +1,9 @@
 package gov.cabinetofice.gapuserservice.exceptions;
 
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(HttpStatus.NOT_FOUND)
 public class UserNotFoundException extends RuntimeException {
     public UserNotFoundException(String message) {
         super(message);

src/main/java/gov/cabinetofice/gapuserservice/mappers/DepartmentMapper.java

@@ -0,0 +1,10 @@
+package gov.cabinetofice.gapuserservice.mappers;
+
+import gov.cabinetofice.gapuserservice.dto.DepartmentDto;
+import gov.cabinetofice.gapuserservice.model.Department;
+import org.mapstruct.Mapper;
+
+@Mapper(componentModel = "spring")
+public interface DepartmentMapper {
+    DepartmentDto departmentToDepartmentDto(Department dept);
+}

src/main/java/gov/cabinetofice/gapuserservice/mappers/RoleMapper.java

@@ -0,0 +1,10 @@
+package gov.cabinetofice.gapuserservice.mappers;
+import gov.cabinetofice.gapuserservice.model.Role;
+
+import gov.cabinetofice.gapuserservice.dto.RoleDto;
+import org.mapstruct.Mapper;
+
+@Mapper(componentModel = "spring")
+public interface RoleMapper {
+    RoleDto roleToRoleDto(Role role);
+}

src/main/java/gov/cabinetofice/gapuserservice/mappers/UserMapper.java

@@ -0,0 +1,10 @@
+package gov.cabinetofice.gapuserservice.mappers;
+
+import gov.cabinetofice.gapuserservice.dto.UserDto;
+import gov.cabinetofice.gapuserservice.model.User;
+import org.mapstruct.Mapper;
+
+@Mapper(componentModel = "spring")
+public interface UserMapper {
+    UserDto userToUserDto(User user);
+}

src/main/java/gov/cabinetofice/gapuserservice/model/Department.java

@@ -1,5 +1,6 @@
 package gov.cabinetofice.gapuserservice.model;
 
+import com.fasterxml.jackson.annotation.JsonBackReference;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import jakarta.persistence.*;
 import lombok.*;
@@ -29,9 +30,10 @@ public class Department {
     private String ggisID;
 
     @Column(name = "users")
-    @OneToMany(mappedBy="id", cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.LAZY)
+    @OneToMany(mappedBy="gapUserId", cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.LAZY)
     @ToString.Exclude
     @JsonIgnoreProperties({ "hibernateLazyInitializer" })
+    @JsonBackReference
     @Builder.Default
     private List<User> users = new ArrayList<>();
 }

src/main/java/gov/cabinetofice/gapuserservice/model/Role.java

@@ -1,5 +1,6 @@
 package gov.cabinetofice.gapuserservice.model;
 
+import com.fasterxml.jackson.annotation.JsonBackReference;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import jakarta.persistence.*;
 import lombok.*;
@@ -26,15 +27,20 @@ public class Role {
     @Enumerated(EnumType.STRING)
     private RoleEnum name;
 
+    @Column(name = "description")
+    private String description;
+
     @ManyToMany(cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.LAZY)
     @JoinColumn(name = "id", nullable = false)
     @ToString.Exclude
     @JsonIgnoreProperties({ "hibernateLazyInitializer" })
+    @JsonBackReference
     @Builder.Default
     private List<User> users = new ArrayList<>();
 
     public void addUser(User user) {
         this.users.add(user);
     }
+    public void removeUser( User user) { this.users.remove(user); }
 }
 

src/main/java/gov/cabinetofice/gapuserservice/model/User.java

@@ -1,6 +1,7 @@
 package gov.cabinetofice.gapuserservice.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonManagedReference;
 import jakarta.persistence.*;
 import lombok.*;
 
@@ -20,23 +21,25 @@ public class User {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "gap_user_id")
-    private Integer id;
+    private Integer gapUserId;
 
     @Column(name = "email")
-    private String email;
+    private String emailAddress;
 
     @Column(name = "sub")
     private String sub;
 
-    @ManyToMany(cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.EAGER, mappedBy = "users")
+    @ManyToMany(cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.LAZY, mappedBy = "users")
     @ToString.Exclude
     @JsonIgnoreProperties({ "hibernateLazyInitializer" })
+    @JsonManagedReference
     @Builder.Default
     private List<Role> roles = new ArrayList<>();
 
-    @ManyToOne(cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.EAGER)
+    @ManyToOne(cascade = { CascadeType.MERGE, CascadeType.PERSIST }, fetch = FetchType.LAZY)
     @JoinColumn(name = "dept_id")
     @ToString.Exclude
+    @JsonManagedReference
     @JsonIgnoreProperties({ "hibernateLazyInitializer" })
     private Department department;
 
@@ -50,7 +53,7 @@ public boolean hasSub() {
     }
 
     public boolean hasEmail() {
-        return this.email != null;
+        return this.emailAddress != null;
     }
 
     public boolean hasDepartment() {
@@ -68,4 +71,12 @@ public boolean isAdmin() {
     public boolean isSuperAdmin() {
         return this.roles.stream().anyMatch((role) -> role.getName().equals(RoleEnum.SUPER_ADMIN));
     }
+
+    public User removeAllRoles() {
+        for (Role role : this.roles) {
+            role.removeUser(this);
+        }
+        this.roles.clear();
+        return this;
+    }
 }

src/main/java/gov/cabinetofice/gapuserservice/repository/DepartmentRepository.java

@@ -0,0 +1,9 @@
+package gov.cabinetofice.gapuserservice.repository;
+
+import gov.cabinetofice.gapuserservice.model.Department;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface DepartmentRepository extends JpaRepository<Department, Integer> {
+}

src/main/java/gov/cabinetofice/gapuserservice/repository/RoleRepository.java

@@ -10,5 +10,6 @@
 @Repository
 public interface RoleRepository extends JpaRepository<Role, Integer> {
     Optional<Role> findByName(RoleEnum name);
+
 }
 

src/main/java/gov/cabinetofice/gapuserservice/repository/UserRepository.java

@@ -1,14 +1,21 @@
 package gov.cabinetofice.gapuserservice.repository;
 
 import gov.cabinetofice.gapuserservice.model.User;
+import org.springframework.data.jpa.repository.EntityGraph;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
 import java.util.Optional;
 
 @Repository
 public interface UserRepository extends JpaRepository<User, Integer> {
-    Optional<User> findByEmail(String email);
+
+    @EntityGraph(attributePaths = {"department", "roles"})
+    Optional<User> findByEmailAddress(String email);
+    @EntityGraph(attributePaths = {"department", "roles"})
     Optional<User> findBySub(String sub);
+
+    @EntityGraph(attributePaths = {"department", "roles"})
+    Optional<User> findById(int id);
 }
 

src/main/java/gov/cabinetofice/gapuserservice/security/JwtTokenFilter.java

@@ -65,12 +65,12 @@ protected void doFilterInternal(final @NonNull HttpServletRequest request,
         }
 
         //TODO set the Security context, so we can access user details in rest of app
-        final UsernamePasswordAuthenticationToken authentication = new UsernamePasswordAuthenticationToken(
+        final UsernamePasswordAuthenticationToken user_authentication = new UsernamePasswordAuthenticationToken(
                 "Placeholder",
                 null,
                 Collections.singletonList(new SimpleGrantedAuthority("ROLE_USER")));
 
-        SecurityContextHolder.getContext().setAuthentication(authentication);
+        SecurityContextHolder.getContext().setAuthentication(user_authentication);
         chain.doFilter(request, response);
     }