content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.dolphinscheduler.api.security.impl.ldap;
  
  import static org.mockito.ArgumentMatchers.any;
  import static org.mockito.Mockito.when;
  
  import org.apache.dolphinscheduler.api.controller.AbstractControllerTest;
  import org.apache.dolphinscheduler.api.enums.Status;
  import org.apache.dolphinscheduler.api.security.LdapUserNotExistActionType;
  import org.apache.dolphinscheduler.api.service.SessionService;
  import org.apache.dolphinscheduler.api.service.UsersService;
  import org.apache.dolphinscheduler.api.utils.Result;
  import org.apache.dolphinscheduler.common.enums.Flag;
  import org.apache.dolphinscheduler.common.enums.UserType;
  import org.apache.dolphinscheduler.dao.entity.Session;
  import org.apache.dolphinscheduler.dao.entity.User;
  
  import java.util.Date;
  import java.util.Map;
  import java.util.UUID;
  
  import javax.servlet.http.HttpServletRequest;
  
  import org.junit.jupiter.api.Assertions;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  import org.mockito.Mockito;
  import org.mockito.Spy;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
  import org.springframework.boot.test.mock.mockito.MockBean;
  import org.springframework.test.context.TestPropertySource;
  
  @TestPropertySource(properties = {
          "security.authentication.type=LDAP",
          "security.authentication.ldap.user.admin=read-only-admin",
          "security.authentication.ldap.urls=ldap://ldap.forumsys.com:389/",
          "security.authentication.ldap.base-dn=dc=example,dc=com",
          "security.authentication.ldap.username=cn=read-only-admin,dc=example,dc=com",
          "security.authentication.ldap.password=password",
          "security.authentication.ldap.user.identity-attribute=uid",
          "security.authentication.ldap.user.email-attribute=mail",
          "security.authentication.ldap.user.not-exist-action=CREATE",
          "security.authentication.ldap.ssl.enable=false",
          "security.authentication.ldap.ssl.trust-store=",
          "security.authentication.ldap.ssl.trust-store-password=",
  })
  public class LdapAuthenticatorTest extends AbstractControllerTest {
  
      private static Logger logger = LoggerFactory.getLogger(LdapAuthenticatorTest.class);
      @Autowired
      protected AutowireCapableBeanFactory beanFactory;
      @MockBean(name = "ldapService")
      private LdapService ldapService;
      @MockBean(name = "sessionServiceImpl")
      private SessionService sessionService;
      @Spy
      private UsersService usersService;
  
      private LdapAuthenticator ldapAuthenticator;
  
      // test param
      private User mockUser;
      private Session mockSession;
  
      private String ldapUid = "test";
      private String ldapUserPwd = "password";
      private String ldapEmail = "test@example.com";
      private String ip = "127.0.0.1";
      private UserType userType = UserType.GENERAL_USER;
  
      @Override
      @BeforeEach
      public void setUp() {
          ldapAuthenticator = new LdapAuthenticator();
          beanFactory.autowireBean(ldapAuthenticator);
  
          mockUser = new User();
          mockUser.setId(1);
          mockUser.setUserName(ldapUid);
          mockUser.setEmail(ldapEmail);
          mockUser.setUserType(userType);
          mockUser.setState(Flag.YES.getCode());
  
          mockSession = new Session();
          mockSession.setId(UUID.randomUUID().toString());
          mockSession.setIp(ip);
          mockSession.setUserId(1);
          mockSession.setLastLoginTime(new Date());
      }
  
      @Test
      public void testAuthenticate() {
          when(ldapService.ldapLogin(ldapUid, ldapUserPwd)).thenReturn(ldapEmail);
          when(sessionService.createSessionIfAbsent(Mockito.any(User.class))).thenReturn(mockSession);
  
          // test username pwd correct and user not exist, config user not exist action deny, so login denied
          when(ldapService.getLdapUserNotExistAction()).thenReturn(LdapUserNotExistActionType.DENY);
          when(ldapService.createIfUserNotExists()).thenReturn(false);
          Result<Map<String, String>> result = ldapAuthenticator.authenticate(ldapUid, ldapUserPwd, ip);
          Assertions.assertEquals(Status.USER_NAME_PASSWD_ERROR.getCode(), (int) result.getCode());
  
          // test username pwd correct and user not exist, config user not exist action create, so login success
          when(ldapService.getLdapUserNotExistAction()).thenReturn(LdapUserNotExistActionType.CREATE);
          when(ldapService.createIfUserNotExists()).thenReturn(true);
          result = ldapAuthenticator.authenticate(ldapUid, ldapUserPwd, ip);
          Assertions.assertEquals(Status.SUCCESS.getCode(), (int) result.getCode());
          logger.info(result.toString());
  
          // test username pwd correct and user not exist, config action create but can't create session, so login failed
          when(sessionService.createSessionIfAbsent(Mockito.any(User.class))).thenReturn(null);
          result = ldapAuthenticator.authenticate(ldapUid, ldapUserPwd, ip);
          Assertions.assertEquals(Status.LOGIN_SESSION_FAILED.getCode(), (int) result.getCode());
  
          // test username pwd error, login failed
          when(ldapService.ldapLogin(ldapUid, ldapUserPwd)).thenReturn(null);
          result = ldapAuthenticator.authenticate(ldapUid, ldapUserPwd, ip);
          Assertions.assertEquals(Status.USER_NAME_PASSWD_ERROR.getCode(), (int) result.getCode());
      }
  
      @Test
      public void testGetAuthUser() {
          HttpServletRequest request = Mockito.mock(HttpServletRequest.class);
          when(usersService.queryUser(mockUser.getId())).thenReturn(mockUser);
          when(sessionService.getSession(any())).thenReturn(mockSession);
  
          User user = ldapAuthenticator.getAuthUser(request);
          Assertions.assertNotNull(user);
  
          when(sessionService.getSession(any())).thenReturn(null);
          user = ldapAuthenticator.getAuthUser(request);
          Assertions.assertNull(user);
      }
  }
  