implement first user is admin option (#560)

* implement first user is admin option
add tests to cover it

Author: blabadi

.gitignore

@@ -4,7 +4,7 @@ env.sh
 
 ### Java Wrapper Logs ###
 *wrapper*.log
-
+*.log
 
 ### STS ###
 .apt_generated
@@ -30,7 +30,6 @@ nbdist/
 
 ### VSCode ###
 .vscode
-
 .env
 
 ### Docs ###
@@ -41,4 +40,5 @@ _templates/
 
 classes/
 
-local.log
+local.log
+*.local.yaml

src/main/java/bio/overture/ego/config/UserDefaultsConfig.java

@@ -19,10 +19,14 @@ public class UserDefaultsConfig {
 
   @Getter private final StatusType defaultUserStatus;
 
+  @Getter private final boolean firstUserAsAdmin;
+
   public UserDefaultsConfig(
       @Value("${default.user.type}") String userType,
-      @Value("${default.user.status}") String userStatus) {
+      @Value("${default.user.status}") String userStatus,
+      @Value("${default.user.firstUserAsAdmin:false}") boolean firstUserAsAdmin) {
     this.defaultUserType = isEmpty(userType) ? USER : resolveUserType(userType);
     this.defaultUserStatus = isEmpty(userStatus) ? PENDING : resolveStatusType(userStatus);
+    this.firstUserAsAdmin = firstUserAsAdmin;
   }
 }

src/main/java/bio/overture/ego/repository/BaseRepository.java

@@ -9,6 +9,7 @@
 @NoRepositoryBean
 public interface BaseRepository<T, ID>
     extends PagingAndSortingRepository<T, ID>, JpaSpecificationExecutor {
+  T findFirstBy();
 
   Set<T> findAllByIdIn(Collection<ID> ids);
 }

src/main/java/bio/overture/ego/service/AbstractBaseService.java

@@ -56,6 +56,11 @@ public void delete(@NonNull ID id) {
     getRepository().deleteById(id);
   }
 
+  @Override
+  public long countAll() {
+    return getRepository().count();
+  }
+
   @Override
   @SuppressWarnings("unchecked")
   public Page<T> findAll(@NonNull Specification specification, @NonNull Pageable pageable) {

src/main/java/bio/overture/ego/service/BaseService.java

@@ -34,6 +34,8 @@ default T getById(@NonNull ID id) {
 
   void delete(ID id);
 
+  long countAll();
+
   Page<T> findAll(Specification specification, Pageable pageable);
 
   Page<T> findAll(AbstractSpecificationBuilder<T, ID> specificationBuilder, Pageable pageable);

src/main/java/bio/overture/ego/service/UserService.java

@@ -41,6 +41,7 @@
 import bio.overture.ego.model.dto.UpdateUserRequest;
 import bio.overture.ego.model.entity.*;
 import bio.overture.ego.model.enums.ProviderType;
+import bio.overture.ego.model.enums.StatusType;
 import bio.overture.ego.model.join.UserApplication;
 import bio.overture.ego.model.join.UserGroup;
 import bio.overture.ego.model.search.SearchFilter;
@@ -99,6 +100,11 @@ public UserService(
   public User create(@NonNull CreateUserRequest request) {
     validateCreateRequest(request);
     val user = USER_CONVERTER.convertToUser(request);
+    val existingRandomUser = getRepository().findFirstBy();
+    if (userDefaultsConfig.isFirstUserAsAdmin() && existingRandomUser == null) {
+      user.setType(ADMIN);
+      user.setStatus(StatusType.APPROVED);
+    }
     return getRepository().save(user);
   }
 

src/main/resources/application.yml

@@ -163,6 +163,8 @@ token:
 # Default values available for creation of entities
 default:
   user:
+    # flag to automatically register first user as an admin
+    firstUserAsAdmin: false
     type: USER
     status: APPROVED
 

src/test/java/bio/overture/ego/controller/AbstractMockedTokenControllerTest.java

@@ -3,6 +3,7 @@
 import static org.mockito.Mockito.mock;
 import static org.springframework.test.web.servlet.setup.MockMvcBuilders.webAppContextSetup;
 
+import bio.overture.ego.model.entity.User;
 import bio.overture.ego.model.enums.ProviderType;
 import bio.overture.ego.provider.google.GoogleTokenService;
 import bio.overture.ego.service.TokenService;
@@ -19,9 +20,12 @@
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.web.context.WebApplicationContext;
 
+import java.util.List;
+
 public abstract class AbstractMockedTokenControllerTest extends AbstractControllerTest {
 
   protected boolean hasRunEntitySetup = false;
+  protected List<User> testUsers;
   protected MockMvc mockMvc;
 
   @Value("${spring.flyway.placeholders.default-provider:GOOGLE}")
@@ -54,7 +58,7 @@ protected boolean enableLogging() {
   protected void beforeTest() {
     // Initial setup of entities (run once)
     if (!hasRunEntitySetup) {
-      entityGenerator.setupTestUsers();
+      testUsers = entityGenerator.setupTestUsers();
       hasRunEntitySetup = true;
     }
 

src/test/java/bio/overture/ego/service/FirstUserAsAdminTest.java

@@ -0,0 +1,43 @@
+package bio.overture.ego.service;
+
+import bio.overture.ego.model.entity.User;
+import bio.overture.ego.model.enums.UserType;
+import bio.overture.ego.utils.EntityGenerator;
+import lombok.extern.slf4j.Slf4j;
+import lombok.val;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.transaction.annotation.Transactional;
+
+@Slf4j
+@SpringBootTest
+@RunWith(SpringRunner.class)
+@ActiveProfiles("test")
+@TestPropertySource(properties = "default.user.firstUserAsAdmin=true")
+@Transactional
+public class FirstUserAsAdminTest {
+
+  @Autowired private UserService userService;
+  @Autowired private EntityGenerator entityGenerator;
+
+  @Test
+  public void testOnlyFirstUserShouldBeAdminByDefault() {
+    userService.getRepository().deleteAll();
+    val usersCount = userService.countAll();
+    Assert.assertEquals(0, usersCount);
+    User u = entityGenerator.setupUser("First User", UserType.USER);
+    val user = userService.findById(u.getId()).get();
+    Assert.assertEquals(user.getType(), UserType.ADMIN);
+
+    // add another user make sure they don't get ADMIN type
+    User u2 = entityGenerator.setupUser("Second User", UserType.USER);
+    val user2 = userService.findById(u2.getId()).get();
+    Assert.assertEquals(user2.getType(), UserType.USER);
+  }
+}

src/test/java/bio/overture/ego/service/UserServiceTest.java

@@ -4,6 +4,8 @@
 import static bio.overture.ego.utils.CollectionUtils.repeatedCallsOf;
 import static java.util.stream.Collectors.toList;
 
+import bio.overture.ego.model.entity.User;
+import bio.overture.ego.model.enums.UserType;
 import bio.overture.ego.utils.EntityGenerator;
 import lombok.extern.slf4j.Slf4j;
 import lombok.val;
@@ -28,6 +30,16 @@ public class UserServiceTest {
   @Autowired private RefreshContextService refreshContextService;
   @Autowired private TokenService tokenService;
 
+  @Test
+  public void testFirstUserShouldNotBeAdminByDefault() {
+    userService.getRepository().deleteAll();
+    val usersCount = userService.countAll();
+    Assert.assertEquals(0, usersCount);
+    User u = entityGenerator.setupUser("First User", UserType.USER);
+    val user = userService.findById(u.getId()).get();
+    Assert.assertEquals(user.getType(), UserType.USER);
+  }
+
   @Test
   public void testGetManyUsersWithRelations() {
     int numUsers = 3;

src/test/java/bio/overture/ego/utils/EntityGenerator.java

@@ -154,8 +154,8 @@ public List<User> setupPublicUsers(String... users) {
         user -> setupUser(user, USER, UUID.randomUUID().toString(), DEFAULT_PROVIDER_TYPE));
   }
 
-  public void setupTestUsers() {
-    setupUsers("First User", "Second User", "Third User");
+  public List<User> setupTestUsers() {
+    return setupUsers("First User", "Second User", "Third User");
   }
 
   public Group setupGroup(String name) {