* All messages received from the remote peer are strings only, but may be JSON formatted.
@@ -56,12 +54,13 @@
*/
public class WebSocketClientService {
-
private StompSession stompSession;
private Runnable connectCallback;
private Runnable disconnectCallback;
private final List
- *
+ * Called if connection fails or if connection is lost (e.g. remote service is terminated).
*
* @param session the client STOMP session
- * @param exception the exception that occurred. This is evaluated to determine if a reconnection
- * thread should be launched.
+ * @param exception the exception that occurred.
*/
@Override
public void handleTransportError(StompSession session, Throwable exception) {
- if(exception instanceof DeploymentException){
- logger.log(Level.WARNING, "Unable to connect", exception);
+ logger.log(Level.WARNING, "Connection failed or lost, will attempt to reconnect", exception);
+ if (disconnectCallback != null && exception instanceof ConnectionLostException) {
+ disconnectCallback.run();
}
- else {
- logger.log(Level.WARNING, "Connection lost, will attempt to reconnect", exception);
- if (exception instanceof ConnectionLostException && disconnectCallback != null) {
- disconnectCallback.run();
- }
+ try {
+ Thread.sleep(10000);
connect();
+ } catch (InterruptedException e) {
+ logger.log(Level.WARNING, "Sleep interrupted", e);
}
}
}
@@ -268,7 +235,7 @@ public static boolean checkAvailability(String webSocketConnectUrl) {
WebSocketClient webSocketClient = new StandardWebSocketClient();
WebSocketStompClient stompClient = new WebSocketStompClient(webSocketClient);
try {
- StompSession stompSession = stompClient.connect(webSocketConnectUrl, new StompSessionHandlerAdapter() {
+ StompSession stompSession = stompClient.connectAsync(webSocketConnectUrl, new StompSessionHandlerAdapter() {
@Override
public Type getPayloadType(StompHeaders headers) {
return super.getPayloadType(headers);
@@ -277,7 +244,7 @@ public Type getPayloadType(StompHeaders headers) {
stompSession.disconnect();
return true;
} catch (Exception e) {
- logger.log(Level.WARNING, "Remote service on " + webSocketConnectUrl + " does not support web socket connection", e);
+ logger.log(Level.WARNING, "Remote service on " + webSocketConnectUrl + " does not support web socket connection on url " + webSocketConnectUrl, e);
}
return false;
}
diff --git a/dependencies/phoebus-target/pom.xml b/dependencies/phoebus-target/pom.xml
index fe2b7ba830..f8620edd50 100644
--- a/dependencies/phoebus-target/pom.xml
+++ b/dependencies/phoebus-target/pom.xml
@@ -223,26 +223,20 @@
null.
*/
public ESTreeNode getParentNode(String uniqueId) {
- Builder bqb = new Builder();
- bqb.must(TermQuery.of(w -> w.field("childNodes").value(uniqueId))._toQuery());
- SearchRequest searchRequest = SearchRequest.of(s -> s.index(ES_TREE_INDEX)
- .query(bqb.build()._toQuery())
- .timeout("60s"));
try {
- SearchResponseauthenticationProviders contains activeDirectory.
+ */
+@SuppressWarnings("unused")
+@EnableWebSecurity
+@Configuration
+@Conditional(value = ActiveDirectorySecurityConfig.ActiveDirectoryCondition.class)
+@PropertySource("${activeDirectoryPropertySource}")
+public class ActiveDirectorySecurityConfig extends WebSecurityConfig {
+
+ @Value("${ad.url:ldap://localhost:389/}")
+ String ad_url;
+ @Value("${ad.domain}")
+ String ad_domain;
+
+ @Bean(WebSecurityConfig.ACTIVE_DIRECTORY)
+ public AuthenticationProvider activeDirectoryLdapAuthenticationProvider() {
+ ActiveDirectoryLdapAuthenticationProvider adProvider = new ActiveDirectoryLdapAuthenticationProvider(ad_domain, ad_url);
+ adProvider.setConvertSubErrorCodesToExceptions(true);
+ adProvider.setUseAuthenticationRequestCredentials(true);
+
+ return adProvider;
+ }
+
+ public static class ActiveDirectoryCondition implements Condition {
+ @Override
+ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+ String value = context.getEnvironment().getProperty(WebSecurityConfig.PROVIDER_LIST_PROPERTY_NAME);
+ if (value == null || value.isEmpty()) {
+ return false;
+ }
+ String[] values = value.split(",");
+ return Arrays.asList(values).contains(WebSecurityConfig.ACTIVE_DIRECTORY);
+ }
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/EmbeddedLdapSecurityConfig.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/EmbeddedLdapSecurityConfig.java
new file mode 100644
index 0000000000..678538b127
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/EmbeddedLdapSecurityConfig.java
@@ -0,0 +1,92 @@
+/*
+ * Copyright 2025 European Spallation Source ERIC.
+ *
+ */
+
+package org.phoebus.service.saveandrestore.web.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.*;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.ldap.core.ContextSource;
+import org.springframework.security.authentication.AuthenticationProvider;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.ldap.DefaultSpringSecurityContextSource;
+import org.springframework.security.ldap.authentication.LdapAuthenticationProvider;
+import org.springframework.security.ldap.authentication.PasswordComparisonAuthenticator;
+import org.springframework.security.ldap.userdetails.DefaultLdapAuthoritiesPopulator;
+
+import java.util.Arrays;
+
+/**
+ * Security config for embedded LDAP authentication/authorization. Instantiated only if runtime property
+ * authenticationProviders contains embedded_ldap.
+ */
+@SuppressWarnings("unused")
+@EnableWebSecurity
+@Configuration
+@Conditional(value = EmbeddedLdapSecurityConfig.EmbeddedLdapCondition.class)
+@PropertySource("${embeddedLdapPropertySource}")
+public class EmbeddedLdapSecurityConfig {
+
+ @Value("${embedded_ldap.url:ldap://localhost:8389/dc=sar,dc=local}")
+ String embedded_ldap_url;
+ @Value("${embedded_ldap.base.dn}")
+ String embedded_ldap_base_dn;
+ @Value("${embedded_ldap.user.dn.pattern}")
+ String embedded_ldap_user_dn_pattern;
+ @Value("${embedded_ldap.groups.search.base}")
+ String embedded_ldap_groups_search_base;
+ @Value("${embedded_ldap.groups.search.pattern}")
+ String embedded_ldap_groups_search_pattern;
+ @Value("${spring.ldap.embedded.port:8389}")
+ int spring_ldap_embedded_port;
+ @Value("${embedded_ldap_ldif:classpath:sar.ldif}")
+ String embedded_ldap_ldif;
+
+ @Bean(WebSecurityConfig.EMBEDDED_LDAP)
+ public AuthenticationProvider ldapAuthenticationProvider(DefaultSpringSecurityContextSource contextSource) {
+
+ PasswordComparisonAuthenticator passwordComparisonAuthenticator = new PasswordComparisonAuthenticator(contextSource);
+ passwordComparisonAuthenticator.setPasswordEncoder(new BCryptPasswordEncoder());
+ passwordComparisonAuthenticator.setUserDnPatterns(new String[]{embedded_ldap_user_dn_pattern});
+
+ return new LdapAuthenticationProvider(passwordComparisonAuthenticator,
+ defaultLdapAuthoritiesPopulator(contextSource));
+ }
+
+
+ @Bean
+ public SaveAndRestoreUnboundIdContainer ldapContainer() {
+ SaveAndRestoreUnboundIdContainer container = new SaveAndRestoreUnboundIdContainer(embedded_ldap_base_dn, embedded_ldap_ldif);
+ container.setPort(spring_ldap_embedded_port);
+ return container;
+ }
+
+ @Bean
+ public DefaultSpringSecurityContextSource contextSource(SaveAndRestoreUnboundIdContainer container) {
+ return new DefaultSpringSecurityContextSource(embedded_ldap_url);
+ }
+
+ private DefaultLdapAuthoritiesPopulator defaultLdapAuthoritiesPopulator(ContextSource contextSource) {
+ DefaultLdapAuthoritiesPopulator myAuthPopulator = new DefaultLdapAuthoritiesPopulator(contextSource, embedded_ldap_groups_search_base);
+ myAuthPopulator.setGroupSearchFilter(embedded_ldap_groups_search_pattern);
+ myAuthPopulator.setSearchSubtree(true);
+ myAuthPopulator.setIgnorePartialResultException(true);
+
+ return myAuthPopulator;
+ }
+
+ public static class EmbeddedLdapCondition implements Condition {
+ @Override
+ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+ String value = context.getEnvironment().getProperty(WebSecurityConfig.PROVIDER_LIST_PROPERTY_NAME);
+ if (value == null || value.isEmpty()) {
+ return false;
+ }
+ String[] values = value.split(",");
+ return Arrays.asList(values).contains(WebSecurityConfig.EMBEDDED_LDAP);
+ }
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/InMemorySecurityConfig.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/InMemorySecurityConfig.java
new file mode 100644
index 0000000000..c85b378bfd
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/InMemorySecurityConfig.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2026 European Spallation Source ERIC.
+ *
+ */
+
+package org.phoebus.service.saveandrestore.web.config;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.*;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.security.authentication.AuthenticationProvider;
+import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.core.userdetails.User;
+import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.provisioning.InMemoryUserDetailsManager;
+
+import java.util.Arrays;
+
+/**
+ * Security config for in-memory authentication/authorization. Instantiated only if runtime property
+ * authenticationProviders contains inMemory.
+ */
+@SuppressWarnings("unused")
+@EnableWebSecurity
+@Configuration
+@Conditional(value = InMemorySecurityConfig.InMemoryCondition.class)
+@PropertySource("${inMemoryPropertySource}")
+public class InMemorySecurityConfig {
+
+ @Value("${demo.user:user}")
+ private String demoUser;
+
+ @Value("${demo.user.password:userPass}")
+ private String demoUserPassword;
+
+ @Value("${demo.admin:admin}")
+ private String demoAdmin;
+
+ @Value("${demo.admin.password:adminPass}")
+ private String demoAdminPassword;
+
+ @Value("${demo.readOnly:johndoe}")
+ private String demoReadOnly;
+
+ @Value("${demo.readOnly.password:1234}")
+ private String demoReadOnlyPassword;
+
+ @Autowired
+ private String roleUser;
+
+ @Autowired
+ private String roleAdmin;
+
+ @Bean(WebSecurityConfig.IN_MEMORY)
+ public AuthenticationProvider authenticationProvider() {
+ DaoAuthenticationProvider daoAuthenticationProvider = new DaoAuthenticationProvider(userDetailsService());
+ daoAuthenticationProvider.setPasswordEncoder(new BCryptPasswordEncoder());
+ return daoAuthenticationProvider;
+ }
+
+ @Bean
+ public InMemoryUserDetailsManager userDetailsService() {
+ BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
+ UserDetails user = User.builder()
+ .username(demoUser)
+ .password(passwordEncoder.encode(demoUserPassword))
+ .roles(roleUser.toUpperCase())
+ .build();
+ UserDetails adminUser = User.builder()
+ .username(demoAdmin)
+ .password(passwordEncoder.encode(demoAdminPassword))
+ .roles(roleAdmin.toUpperCase())
+ .build();
+ UserDetails readOnlyUser = User.builder()
+ .username(demoReadOnly)
+ .password(passwordEncoder.encode(demoReadOnlyPassword))
+ .build();
+ return new InMemoryUserDetailsManager(user, adminUser, readOnlyUser);
+ }
+
+ public static class InMemoryCondition implements Condition {
+ @Override
+ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+ String value = context.getEnvironment().getProperty(WebSecurityConfig.PROVIDER_LIST_PROPERTY_NAME);
+ if (value == null || value.isEmpty()) {
+ return true;
+ }
+ String[] values = value.split(",");
+ return Arrays.asList(values).contains(WebSecurityConfig.IN_MEMORY);
+ }
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/LdapSecurityConfig.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/LdapSecurityConfig.java
new file mode 100644
index 0000000000..0384a2c578
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/LdapSecurityConfig.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright 2025 European Spallation Source ERIC.
+ *
+ */
+
+package org.phoebus.service.saveandrestore.web.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.*;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.ldap.core.support.DefaultTlsDirContextAuthenticationStrategy;
+import org.springframework.security.authentication.AuthenticationProvider;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.ldap.DefaultSpringSecurityContextSource;
+import org.springframework.security.ldap.authentication.BindAuthenticator;
+import org.springframework.security.ldap.authentication.LdapAuthenticationProvider;
+import org.springframework.security.ldap.search.FilterBasedLdapUserSearch;
+import org.springframework.security.ldap.userdetails.DefaultLdapAuthoritiesPopulator;
+import org.springframework.security.ldap.userdetails.LdapAuthoritiesPopulator;
+
+import java.util.Arrays;
+
+/**
+ * Security config for LDAP authentication/authorization. Instantiated only if runtime property
+ * authenticationProviders contains ldap.
+ */
+@SuppressWarnings("unused")
+@EnableWebSecurity
+@Configuration
+@Conditional(value = LdapSecurityConfig.LdapCondition.class)
+@PropertySource("${ldapPropertySource}")
+public class LdapSecurityConfig {
+
+ @Value("${ldap.enabled:false}")
+ boolean ldap_enabled;
+ @Value("${ldap.starttls:false}")
+ boolean ldap_starttls;
+ @Value("${ldap.urls:ldaps://localhost:389/}")
+ String ldap_url;
+ @Value("${ldap.base.dn}")
+ String ldap_base_dn;
+ @Value("${ldap.user.dn.pattern}")
+ String ldap_user_dn_pattern;
+ @Value("${ldap.groups.search.base}")
+ String ldap_groups_search_base;
+ @Value("${ldap.groups.search.pattern}")
+ String ldap_groups_search_pattern;
+ @Value("${ldap.manager.dn}")
+ String ldap_manager_dn;
+ @Value("${ldap.manager.password}")
+ String ldap_manager_password;
+ @Value("${ldap.user.search.base}")
+ String ldap_user_search_base;
+ @Value("${ldap.user.search.filter}")
+ String ldap_user_search_filter;
+
+ @Bean(WebSecurityConfig.LDAP)
+ public AuthenticationProvider authenticationProvider() {
+ DefaultSpringSecurityContextSource defaultSpringSecurityContextSource = defaultSpringSecurityContextSource();
+ BindAuthenticator authenticator = new BindAuthenticator(defaultSpringSecurityContextSource);
+ authenticator.setUserDnPatterns(new String[]{ldap_user_dn_pattern});
+ FilterBasedLdapUserSearch filterBasedLdapUserSearch =
+ new FilterBasedLdapUserSearch(ldap_user_search_base, ldap_user_search_filter, defaultSpringSecurityContextSource);
+ authenticator.setUserSearch(filterBasedLdapUserSearch);
+
+ return new LdapAuthenticationProvider(authenticator,
+ ldapAuthoritiesPopulator(defaultSpringSecurityContextSource));
+ }
+
+ private LdapAuthoritiesPopulator ldapAuthoritiesPopulator(DefaultSpringSecurityContextSource contextSource) {
+ DefaultLdapAuthoritiesPopulator myAuthPopulator =
+ new DefaultLdapAuthoritiesPopulator(contextSource, ldap_groups_search_base);
+ myAuthPopulator.setGroupSearchFilter(ldap_groups_search_pattern);
+ myAuthPopulator.setSearchSubtree(true);
+ myAuthPopulator.setIgnorePartialResultException(true);
+
+ return myAuthPopulator;
+ }
+
+ private DefaultSpringSecurityContextSource defaultSpringSecurityContextSource() {
+ DefaultSpringSecurityContextSource contextSource = new DefaultSpringSecurityContextSource(ldap_url);
+ if (ldap_manager_dn != null && !ldap_manager_dn.isEmpty() && ldap_manager_password != null && !ldap_manager_password.isEmpty()) {
+ contextSource.setUserDn(ldap_manager_dn);
+ contextSource.setPassword(ldap_manager_password);
+ }
+ if (ldap_starttls) {
+ contextSource.setAuthenticationStrategy(new DefaultTlsDirContextAuthenticationStrategy());
+ }
+ contextSource.afterPropertiesSet();
+
+ return contextSource;
+ }
+
+ public static class LdapCondition implements Condition {
+ @Override
+ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+ String value = context.getEnvironment().getProperty(WebSecurityConfig.PROVIDER_LIST_PROPERTY_NAME);
+ if (value == null || value.isEmpty()) {
+ return false;
+ }
+ String[] values = value.split(",");
+ return Arrays.asList(values).contains(WebSecurityConfig.LDAP);
+ }
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/SaveAndRestoreUnboundIdContainer.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/SaveAndRestoreUnboundIdContainer.java
new file mode 100644
index 0000000000..3a2e090c3c
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/SaveAndRestoreUnboundIdContainer.java
@@ -0,0 +1,127 @@
+/*
+ * Copyright 2025 European Spallation Source ERIC.
+ *
+ */
+
+package org.phoebus.service.saveandrestore.web.config;
+
+import com.unboundid.ldap.listener.InMemoryDirectoryServer;
+import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
+import com.unboundid.ldap.listener.InMemoryListenerConfig;
+import com.unboundid.ldap.sdk.DN;
+import com.unboundid.ldap.sdk.Entry;
+import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldif.LDIFReader;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.DisposableBean;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.Lifecycle;
+import org.springframework.core.io.Resource;
+import org.springframework.lang.NonNull;
+import org.springframework.security.ldap.server.EmbeddedLdapServerContainer;
+import org.springframework.util.StringUtils;
+
+import java.io.InputStream;
+
+/**
+ * This is a modification of {@link org.springframework.security.ldap.server.UnboundIdContainer} for the purpose
+ * of disabling ldif file validation against default schema.
+ */
+public class SaveAndRestoreUnboundIdContainer implements EmbeddedLdapServerContainer, InitializingBean, DisposableBean, Lifecycle, ApplicationContextAware {
+
+ private InMemoryDirectoryServer directoryServer;
+ private final String defaultPartitionSuffix;
+ private int port = 53389;
+ private boolean isEphemeral;
+ private ConfigurableApplicationContext context;
+ private boolean running;
+ private final String ldif;
+
+ public SaveAndRestoreUnboundIdContainer(String defaultPartitionSuffix, String ldif) {
+ this.defaultPartitionSuffix = defaultPartitionSuffix;
+ this.ldif = ldif;
+ }
+
+ public int getPort() {
+ return this.port;
+ }
+
+ public void setPort(int port) {
+ this.port = port;
+ this.isEphemeral = port == 0;
+ }
+
+ public void destroy() {
+ this.stop();
+ }
+
+ public void afterPropertiesSet() {
+ this.start();
+ }
+
+ public void setApplicationContext(@NonNull ApplicationContext applicationContext) throws BeansException {
+ this.context = (ConfigurableApplicationContext)applicationContext;
+ }
+
+ public void start() {
+ if (!this.isRunning()) {
+ try {
+ InMemoryDirectoryServerConfig config = new InMemoryDirectoryServerConfig(new String[]{this.defaultPartitionSuffix});
+ config.addAdditionalBindCredentials("uid=admin,ou=system", "secret");
+ config.setListenerConfigs(new InMemoryListenerConfig[]{InMemoryListenerConfig.createLDAPConfig("LDAP", this.port)});
+ config.setEnforceSingleStructuralObjectClass(false);
+ config.setEnforceAttributeSyntaxCompliance(true);
+ // Setting null schema disables ldif validation
+ config.setSchema(null);
+
+ DN dn = new DN(this.defaultPartitionSuffix);
+ Entry entry = new Entry(dn);
+ entry.addAttribute("objectClass", new String[]{"top", "domain", "extensibleObject"});
+ entry.addAttribute("dc", dn.getRDN().getAttributeValues()[0]);
+ InMemoryDirectoryServer directoryServer = new InMemoryDirectoryServer(config);
+ directoryServer.add(entry);
+ this.importLdif(directoryServer);
+ directoryServer.startListening();
+ this.port = directoryServer.getListenPort();
+ this.directoryServer = directoryServer;
+ this.running = true;
+ } catch (LDAPException ex) {
+ throw new RuntimeException("Server startup failed", ex);
+ }
+ }
+ }
+
+ private void importLdif(InMemoryDirectoryServer directoryServer) {
+ if (StringUtils.hasText(this.ldif)) {
+ try {
+ Resource[] resources = this.context.getResources(this.ldif);
+ if (resources.length > 0) {
+ if (!resources[0].exists()) {
+ throw new IllegalArgumentException("Unable to find LDIF resource " + this.ldif);
+ }
+
+ try (InputStream inputStream = resources[0].getInputStream()) {
+ directoryServer.importFromLDIF(false, new LDIFReader(inputStream));
+ }
+ }
+ } catch (Exception ex) {
+ throw new IllegalStateException("Unable to load LDIF " + this.ldif, ex);
+ }
+ }
+
+ }
+
+ public void stop() {
+ if (!this.isEphemeral || this.context == null || this.context.isClosed()) {
+ this.directoryServer.shutDown(true);
+ this.running = false;
+ }
+ }
+
+ public boolean isRunning() {
+ return this.running;
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebConfiguration.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebConfiguration.java
index 63fe8a2dc1..1530c661f3 100644
--- a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebConfiguration.java
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebConfiguration.java
@@ -27,7 +27,7 @@
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.Scope;
-import javax.servlet.ServletContext;
+import jakarta.servlet.ServletContext;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebSecurityConfig.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebSecurityConfig.java
index 8b2bad60d2..2b465b2c1f 100644
--- a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebSecurityConfig.java
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/config/WebSecurityConfig.java
@@ -1,33 +1,32 @@
-package org.phoebus.service.saveandrestore.web.config;
-
-import com.fasterxml.jackson.databind.DeserializationFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
+/*
+ * Copyright (C) 2026 European Spallation Source ERIC.
+ *
+ */package org.phoebus.service.saveandrestore.web.config;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.security.authentication.AuthenticationProvider;
+import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
+import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.core.userdetails.UsernameNotFoundException;
+import tools.jackson.databind.DeserializationFeature;
+import tools.jackson.databind.ObjectMapper;
import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.*;
-import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.http.HttpMethod;
-import org.springframework.ldap.core.support.BaseLdapPathContextSource;
import org.springframework.security.access.hierarchicalroles.RoleHierarchy;
import org.springframework.security.access.hierarchicalroles.RoleHierarchyImpl;
import org.springframework.security.authentication.AuthenticationManager;
-import org.springframework.security.config.annotation.ObjectPostProcessor;
-import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
-import org.springframework.security.config.annotation.authentication.configurers.ldap.LdapAuthenticationProviderConfigurer;
-import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer;
-import org.springframework.security.config.ldap.LdapBindAuthenticationManagerFactory;
-import org.springframework.security.core.authority.mapping.SimpleAuthorityMapper;
-import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
-import org.springframework.security.crypto.password.PasswordEncoder;
-import org.springframework.security.ldap.DefaultSpringSecurityContextSource;
-import org.springframework.security.ldap.authentication.ad.ActiveDirectoryLdapAuthenticationProvider;
-import org.springframework.security.ldap.userdetails.DefaultLdapAuthoritiesPopulator;
-import org.springframework.security.ldap.userdetails.LdapAuthoritiesPopulator;
-import org.springframework.security.ldap.userdetails.PersonContextMapper;
import org.springframework.security.web.SecurityFilterChain;
+import tools.jackson.databind.json.JsonMapper;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import static org.springframework.security.config.Customizer.withDefaults;
/**
* {@link Configuration} class setting up authentication/authorization depending on the
@@ -35,44 +34,22 @@
*/
@Configuration
@EnableWebSecurity
-@EnableGlobalMethodSecurity(prePostEnabled = true)
+@EnableMethodSecurity(prePostEnabled = true)
@SuppressWarnings("unused")
public class WebSecurityConfig {
- /**
- * Authentication implementation.
- */
- @Value("${auth.impl:demo}")
- protected String authenitcationImplementation;
+ public static final String IN_MEMORY = "inMemory";
+ public static final String EMBEDDED_LDAP = "embeddedLdap";
+ public static final String LDAP = "ldap";
+ public static final String ACTIVE_DIRECTORY = "activeDirectory";
/**
- * External Active Directory configuration properties
- */
- @Value("${ad.url:ldap://localhost:389/}")
- String ad_url;
- @Value("${ad.domain}")
- String ad_domain;
- /**
- * External LDAP configuration properties
+ * List of supported provider implementations.
*/
- @Value("${ldap.urls:ldaps://localhost:389/}")
- String ldap_url;
- @Value("${ldap.base.dn}")
- String ldap_base_dn;
- @Value("${ldap.user.dn.pattern}")
- String ldap_user_dn_pattern;
- @Value("${ldap.groups.search.base}")
- String ldap_groups_search_base;
- @Value("${ldap.groups.search.pattern}")
- String ldap_groups_search_pattern;
- @Value("${ldap.manager.dn}")
- String ldap_manager_dn;
- @Value("${ldap.manager.password}")
- String ldap_manager_password;
- @Value("${ldap.user.search.base:invalid}")
- String ldap_user_search_base;
- @Value("${ldap.user.search.filter:invalid}")
- String ldap_user_search_filter;
+ private static final String[] PROVIDER_NAME_LIST = {LDAP, ACTIVE_DIRECTORY, EMBEDDED_LDAP, IN_MEMORY};
+
+ public static final String PROVIDER_LIST_PROPERTY_NAME = "authenticationProviders";
+
@Value("${role.user:sar-user}")
private String roleUser;
@@ -80,24 +57,6 @@ public class WebSecurityConfig {
@Value("${role.admin:sar-admin}")
private String roleAdmin;
- @Value("${demo.user:user}")
- private String demoUser;
-
- @Value("${demo.user.password:userPass}")
- private String demoUserPassword;
-
- @Value("${demo.admin:admin}")
- private String demoAdmin;
-
- @Value("${demo.admin.password:adminPass}")
- private String demoAdminPassword;
-
- @Value("${demo.readOnly:johndoe}")
- private String demoReadOnly;
-
- @Value("${demo.readOnly.password:1234}")
- private String demoReadOnlyPassword;
-
/**
*
* @return name of regular user role
@@ -116,68 +75,34 @@ public String roleAdmin() {
return roleAdmin.toUpperCase();
}
- /**
- *
- * @return Identity of demo regular user
- */
- @Bean
- public String demoUser(){
- return demoUser;
- }
-
- /**
- *
- * @return Password of demo regular user
- */
- @Bean
- public String demoUserPassword(){
- return demoUserPassword;
- }
-
- /**
- *
- * @return Identity of the demo admin user.
- */
- @Bean
- public String demoAdmin(){
- return demoAdmin;
- }
-
- /**
- *
- * @return Password of the demo admin user.
- */
- @Bean
- public String demoAdminPassword(){
- return demoAdminPassword;
- }
-
- /**
- *
- * @return Identity of the demo read-only user.
- */
- @Bean
- public String demoReadOnly(){
- return demoReadOnly;
- }
-
- /**
- *
- * @return Password of the demo read-only user.
- */
- @Bean
- public String demoReadOnlyPassword(){
- return demoReadOnlyPassword;
- }
/**
*
* @return The authentication implementation as specified in application property auth.impl.
*/
@SuppressWarnings("unused")
+ @Autowired
+ private ApplicationContext context;
+
+ private final Logger logger = Logger.getLogger(WebSecurityConfig.class.getName());
+
@Bean
- public String authenticationImplementation(){
- return authenitcationImplementation;
+ @Scope("singleton")
+ public AuthenticationManager authenticationManager() throws Exception {
+ return authentication -> {
+ for (String providerName : PROVIDER_NAME_LIST) {
+ if (context.containsBean(providerName)) {
+ AuthenticationProvider authenticationProvider = context.getBean(providerName, AuthenticationProvider.class);
+ logger.log(Level.INFO, "Authenticating user '" + authentication.getPrincipal() + "' with provider '" + providerName + "'");
+ try {
+ return authenticationProvider.authenticate(authentication);
+ } catch (AuthenticationException e) {
+ logger.log(Level.WARNING, "Authentication failed using provider '" + providerName + "'", e);
+ }
+ }
+ }
+ throw new UsernameNotFoundException("");
+ };
}
/**
@@ -188,8 +113,8 @@ public String authenticationImplementation(){
public WebSecurityCustomizer ignoringCustomizer() {
return web -> {
// The below lists exceptions for authentication.
- web.ignoring().antMatchers(HttpMethod.GET, "/**");
- web.ignoring().antMatchers(HttpMethod.POST, "/**/login*");
+ web.ignoring().requestMatchers(HttpMethod.GET, "/**");
+ web.ignoring().requestMatchers(HttpMethod.POST, "/**/login*");
};
}
@@ -200,129 +125,13 @@ public WebSecurityCustomizer ignoringCustomizer() {
* @throws Exception on failure
*/
@Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http.csrf().disable();
- http.authorizeRequests().anyRequest().authenticated();
- http.httpBasic();
+ public SecurityFilterChain filterChain(HttpSecurity http) {
+ http.csrf(csrf -> csrf.disable());
+ http.authorizeHttpRequests(auth -> auth.anyRequest().authenticated());
+ http.httpBasic(withDefaults());
return http.build();
}
- /**
- * Created based on condition implemented in {@link LdapAuthCondition}.
- * @return A {@link DefaultSpringSecurityContextSource} object
- */
- @Bean
- @Conditional(LdapAuthCondition.class)
- public DefaultSpringSecurityContextSource contextSourceFactoryBeanLdap() {
- DefaultSpringSecurityContextSource contextSource = new DefaultSpringSecurityContextSource(ldap_url);
- if (ldap_manager_dn != null && !ldap_manager_dn.isEmpty() && ldap_manager_password != null && !ldap_manager_password.isEmpty()) {
- contextSource.setUserDn(ldap_manager_dn);
- contextSource.setPassword(ldap_manager_password);
- }
- contextSource.setBase(ldap_base_dn);
- return contextSource;
- }
-
-
- /**
- * Created based on condition implemented in {@link LdapAuthCondition}.
- * @param contextSource provided by Spring
- * @return A {@link AuthenticationManager} object
- */
- @Bean
- @Conditional(LdapAuthCondition.class)
- public AuthenticationManager ldapAuthenticationManager(
- BaseLdapPathContextSource contextSource) {
- LdapBindAuthenticationManagerFactory factory =
- new LdapBindAuthenticationManagerFactory(contextSource);
- factory.setUserDnPatterns(ldap_user_dn_pattern);
- factory.setUserDetailsContextMapper(new PersonContextMapper());
-
- factory.setLdapAuthoritiesPopulator(authorities(contextSource));
- return factory.createAuthenticationManager();
- }
-
- /**
- * Created based on condition implemented in {@link LdapAuthCondition}.
- * @param contextSource provided by Spring
- * @return A {@link LdapAuthoritiesPopulator} object
- */
- @Bean
- @Conditional(LdapAuthCondition.class)
- public LdapAuthoritiesPopulator authorities(BaseLdapPathContextSource contextSource) {
- DefaultLdapAuthoritiesPopulator myAuthPopulator = new DefaultLdapAuthoritiesPopulator(contextSource, ldap_groups_search_base);
- myAuthPopulator.setGroupSearchFilter(ldap_groups_search_pattern);
- myAuthPopulator.setSearchSubtree(true);
- myAuthPopulator.setIgnorePartialResultException(true);
- LdapAuthenticationProviderConfigurer configurer = new LdapAuthenticationProviderConfigurer();
- if (ldap_user_dn_pattern != null && !ldap_user_dn_pattern.isEmpty()) {
- configurer.userDnPatterns(ldap_user_dn_pattern);
- }
- if (ldap_user_search_filter != null && !ldap_user_search_filter.isEmpty()) {
- configurer.userSearchFilter(ldap_user_search_filter);
- }
- if (ldap_user_search_base != null && !ldap_user_search_base.isEmpty()) {
- configurer.userSearchBase(ldap_user_search_base);
- }
- configurer.contextSource(contextSource);
- return myAuthPopulator;
- }
-
- /**
- * Created only if application property auth.impl = ad.
- * @return A {@link AuthenticationManager} object
- * @throws Exception on error
- */
- @Bean
- @ConditionalOnProperty(name = "auth.impl", havingValue = "ad")
- public AuthenticationManager authenticationProvider() throws Exception {
- ActiveDirectoryLdapAuthenticationProvider adProvider =
- new ActiveDirectoryLdapAuthenticationProvider(ad_domain, ad_url);
- adProvider.setConvertSubErrorCodesToExceptions(true);
- adProvider.setUseAuthenticationRequestCredentials(true);
- adProvider.setUserDetailsContextMapper(new PersonContextMapper());
- SimpleAuthorityMapper simpleAuthorityMapper = new SimpleAuthorityMapper();
- simpleAuthorityMapper.setConvertToUpperCase(true);
- adProvider.setAuthoritiesMapper(simpleAuthorityMapper);
- return new AuthenticationManagerBuilder(new ObjectPostProcessor<>() {
- @Override
- public true if application property auth.impl is ldap
- * or ldap_embedded, otherwise false.
- */
- @Override
- public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
- String testValue = context.getEnvironment().getProperty("auth.impl");
- return "ldap".equals(testValue) || "ldap_embedded".equals(testValue);
- }
+ return RoleHierarchyImpl.fromHierarchy("ROLE_" + roleAdmin.toUpperCase() + " > ROLE_" + roleUser.toUpperCase());
}
}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/controllers/AuthenticationController.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/controllers/AuthenticationController.java
index 7a87af6a8e..917162bfbf 100644
--- a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/controllers/AuthenticationController.java
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/web/controllers/AuthenticationController.java
@@ -62,9 +62,7 @@ public ResponseEntity- * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - *
- * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - *
- * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * Copyright (C) 2026 European Spallation Source ERIC. */ package org.phoebus.service.saveandrestore.web.config; import co.elastic.clients.elasticsearch.ElasticsearchClient; +import co.elastic.clients.transport.rest5_client.low_level.Rest5Client; +import jakarta.servlet.*; import org.mockito.Mockito; import org.phoebus.saveandrestore.util.SnapshotUtil; import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO; @@ -28,45 +16,76 @@ import org.phoebus.service.saveandrestore.persistence.dao.impl.elasticsearch.SnapshotDataRepository; import org.phoebus.service.saveandrestore.search.SearchUtil; import org.phoebus.service.saveandrestore.websocket.WebSocketService; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.TestConfiguration; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.ComponentScan; -import org.springframework.context.annotation.Profile; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.*; import org.springframework.messaging.simp.SimpMessagingTemplate; import org.springframework.messaging.simp.user.SimpUserRegistry; import org.springframework.mock.web.MockServletContext; -import org.springframework.util.Base64Utils; + +import java.util.Base64; + +import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; +import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.socket.WebSocketSession; +import tools.jackson.databind.ObjectMapper; +import tools.jackson.databind.json.JsonMapper; -import javax.servlet.ServletContext; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; -@TestConfiguration -@ComponentScan(basePackages = "org.phoebus.service.saveandrestore.web.controllers") +@Configuration +@ComponentScan(basePackages = {"org.phoebus.service.saveandrestore.web.controllers", + "org.phoebus.service.saveandrestore.web.config"}) @SuppressWarnings("unused") +@EnableWebMvc +@EnableWebSecurity @Profile("!IT") public class ControllersTestConfig { - @Autowired + @Value("${role.user:sar-user}") + private String roleUser; + + @Value("${role.admin:sar-admin}") + private String roleAdmin; + + @Value("${demo.user:user}") private String demoUser; - @Autowired + @Value("${demo.user.password:userPass}") private String demoUserPassword; - @Autowired + @Value("${demo.admin:admin}") private String demoAdmin; - @Autowired + @Value("${demo.admin.password:adminPass}") private String demoAdminPassword; - @Autowired + @Value("${demo.readOnly:johndoe}") private String demoReadOnly; - @Autowired + @Value("${demo.readOnly.password:1234}") private String demoReadOnlyPassword; + @Bean + public String demoUser() { + return demoUser; + } + + @Bean + public String demoAdmin() { + return demoAdmin; + } + + @Bean() + public String roleAdmin(){ + return roleAdmin.toUpperCase(); + } + + @Bean + public String roleUser(){ + return roleUser.toUpperCase(); + } + @Bean public NodeDAO nodeDAO() { return Mockito.mock(NodeDAO.class); @@ -74,7 +93,7 @@ public NodeDAO nodeDAO() { @Bean public ElasticsearchTreeRepository elasticsearchTreeRepository() { - return Mockito.mock(ElasticsearchTreeRepository.class); + return Mockito.mock(ElasticsearchTreeRepository.class); } @Bean @@ -97,6 +116,16 @@ public ElasticsearchClient client() { return Mockito.mock(ElasticsearchClient.class); } + @Bean("restClient") + public Rest5Client restClient() { + return Mockito.mock(Rest5Client.class); + } + + @Bean("elasticObjectMapper") + public ObjectMapper elasticObjectMapper() { + return JsonMapper.builder().build(); + } + @SuppressWarnings("unused") @Bean public AcceptHeaderResolver acceptHeaderResolver() { @@ -111,17 +140,17 @@ public SearchUtil searchUtil() { @Bean("userAuthorization") public String userAuthorization() { - return "Basic " + Base64Utils.encodeToString((demoUser + ":" + demoUserPassword).getBytes()); + return "Basic " + Base64.getEncoder().encodeToString((demoUser + ":" + demoUserPassword).getBytes()); } @Bean("adminAuthorization") public String adminAuthorization() { - return "Basic " + Base64Utils.encodeToString((demoAdmin + ":" + demoAdminPassword).getBytes()); + return "Basic " + Base64.getEncoder().encodeToString((demoAdmin + ":" + demoAdminPassword).getBytes()); } @Bean("readOnlyAuthorization") public String readOnlyAuthorization() { - return "Basic " + Base64Utils.encodeToString((demoReadOnly + ":" + demoReadOnlyPassword).getBytes()); + return "Basic " + Base64.getEncoder().encodeToString((demoReadOnly + ":" + demoReadOnlyPassword).getBytes()); } @Bean @@ -131,7 +160,7 @@ public ExecutorService executorService() { @Bean public SnapshotUtil snapshotUtil() { - return new SnapshotUtil(); + return new SnapshotUtil(); } @Bean @@ -171,5 +200,4 @@ public String context() { return servletContext().getContextPath().length() > 1 ? servletContext().getContextPath() : ""; } - } diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/WebConfigTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/WebConfigTest.java index 67633bc4df..30bdecd92e 100644 --- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/WebConfigTest.java +++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/WebConfigTest.java @@ -1,36 +1,20 @@ /** - * Copyright (C) 2018 European Spallation Source ERIC. - *
- * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - *
- * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Copyright (C) 2026 European Spallation Source ERIC.
*/
package org.phoebus.service.saveandrestore.web.config;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.ContextHierarchy;
+import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
-@ExtendWith(SpringExtension.class)
-@ContextHierarchy({@ContextConfiguration(classes = {WebConfiguration.class, ControllersTestConfig.class, WebSecurityConfig.class})})
-@TestPropertySource(locations = "classpath:test_application.properties")
+@SpringBootTest(classes = {WebConfiguration.class, ControllersTestConfig.class, WebSecurityConfig.class},
+ webEnvironment = SpringBootTest.WebEnvironment.MOCK)
+@TestPropertySource(locations = "classpath:test_application.properties",
+ properties = "spring.main.allow-bean-definition-overriding=true")
@SuppressWarnings("unused")
public class WebConfigTest {
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/AppMetaDataControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/AppMetaDataControllerTest.java
index 142d9e90da..1f03618e91 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/AppMetaDataControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/AppMetaDataControllerTest.java
@@ -1,34 +1,20 @@
/*
- * Copyright (C) 2018 European Spallation Source ERIC.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Copyright (C) 2026 European Spallation Source ERIC.
*/
package org.phoebus.service.saveandrestore.web.controllers;
+import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;
+import org.junit.jupiter.api.BeforeEach;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
import org.phoebus.service.saveandrestore.web.config.WebSecurityConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.ContextHierarchy;
import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
@@ -41,17 +27,24 @@
* @author georgweiss
* Created 16 May 2019
*/
-@ContextHierarchy({@ContextConfiguration(classes = {ControllersTestConfig.class, WebSecurityConfig.class})})
-@WebMvcTest(AppMetaDataControllerTest.class)
-@ExtendWith(SpringExtension.class)
+@SpringBootTest(classes = {ControllersTestConfig.class, WebSecurityConfig.class},
+ webEnvironment = SpringBootTest.WebEnvironment.MOCK,
+ properties = "spring.main.allow-bean-definition-overriding=true")
@TestPropertySource(locations = "classpath:test_application.properties")
@SuppressWarnings("unused")
-public class AppMetaDataControllerTest {
+public class AppMetaDataControllerTest{
@Autowired
+ private WebApplicationContext webApplicationContext;
+
private MockMvc mockMvc;
+ @BeforeEach
+ void setUp() {
+ mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).apply(springSecurity()).build();
+ }
+
@Value("${app.name}")
private String appName;
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ComparisonControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ComparisonControllerTest.java
index 2b4afe25f8..dff2630675 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ComparisonControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ComparisonControllerTest.java
@@ -1,17 +1,20 @@
/*
- * Copyright (C) 2024 European Spallation Source ERIC.
+ * Copyright (C) 2026 European Spallation Source ERIC.
*/
package org.phoebus.service.saveandrestore.web.controllers;
+import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;
+import org.junit.jupiter.api.BeforeEach;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import tools.jackson.core.type.TypeReference;
+import tools.jackson.databind.ObjectMapper;
import org.epics.vtype.Alarm;
import org.epics.vtype.Display;
import org.epics.vtype.Time;
import org.epics.vtype.VDouble;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
import org.phoebus.applications.saveandrestore.model.ComparisonResult;
import org.phoebus.applications.saveandrestore.model.CompositeSnapshotData;
import org.phoebus.applications.saveandrestore.model.ConfigPv;
@@ -22,13 +25,9 @@
import org.phoebus.applications.saveandrestore.model.SnapshotItem;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
-import org.phoebus.service.saveandrestore.web.config.WebSecurityConfig;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.ContextHierarchy;
+import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
@@ -44,18 +43,26 @@
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
-@ExtendWith(SpringExtension.class)
-@ContextHierarchy({@ContextConfiguration(classes = {ControllersTestConfig.class, WebSecurityConfig.class})})
+@SpringBootTest(
+ classes = {ControllersTestConfig.class},
+ webEnvironment = SpringBootTest.WebEnvironment.MOCK,
+ properties = "spring.main.allow-bean-definition-overriding=true")
@TestPropertySource(locations = "classpath:test_application.properties")
-@WebMvcTest(ComparisonController.class)
public class ComparisonControllerTest {
@Autowired
private NodeDAO nodeDAO;
@Autowired
+ private WebApplicationContext webApplicationContext;
+
private MockMvc mockMvc;
+ @BeforeEach
+ void setUp() {
+ mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).apply(springSecurity()).build();
+ }
+
private final ObjectMapper objectMapper = new ObjectMapper();
@Test
@@ -94,7 +101,8 @@ public void testSingleSnapshot() throws Exception {
ConfigPv configPv2 = new ConfigPv();
configPv2.setPvName("loc://y(771.0)");
- when(nodeDAO.getParentNode("nodeId")).thenReturn(Node.builder().nodeType(NodeType.CONFIGURATION).uniqueId("configId").build());
+ when(nodeDAO.getParentNode("nodeId")).thenReturn(Node.builder().nodeType(NodeType.CONFIGURATION)
+ .uniqueId("configId").build());
ConfigurationData configurationData = new ConfigurationData();
configurationData.setUniqueId("configId");
@@ -120,10 +128,13 @@ public void testSingleSnapshot() throws Exception {
MvcResult result = mockMvc.perform(request).andExpect(status().isOk()).andExpect(content().contentType(JSON))
.andReturn();
+ String responseBody = result.getResponse().getContentAsString();
+
List
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Copyright (C) 2026 European Spallation Source ERIC.
*/
package org.phoebus.service.saveandrestore.web.controllers;
+import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;
+import org.junit.jupiter.api.BeforeEach;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import tools.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
import org.phoebus.applications.saveandrestore.model.Node;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
import org.phoebus.service.saveandrestore.web.config.WebSecurityConfig;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.ContextHierarchy;
import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
@@ -47,10 +33,10 @@
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
-@ExtendWith(SpringExtension.class)
-@ContextHierarchy({@ContextConfiguration(classes = {ControllersTestConfig.class, WebSecurityConfig.class})})
+@SpringBootTest(classes = {ControllersTestConfig.class, WebSecurityConfig.class},
+ webEnvironment = SpringBootTest.WebEnvironment.MOCK,
+ properties = "spring.main.allow-bean-definition-overriding=true")
@TestPropertySource(locations = "classpath:test_application_permit_all.properties")
-@WebMvcTest(NodeController.class)
/**
* Main purpose of the tests in this class is to verify that REST end points are
* maintained, i.e. that URLs are not changed and that they return the correct
@@ -65,8 +51,15 @@ public class NodeControllerPermitAllTest {
private NodeDAO nodeDAO;
@Autowired
+ private WebApplicationContext webApplicationContext;
+
private MockMvc mockMvc;
+ @BeforeEach
+ void setUp() {
+ mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).apply(springSecurity()).build();
+ }
+
private static Node folderFromClient;
private final ObjectMapper objectMapper = new ObjectMapper();
@@ -81,7 +74,7 @@ public class NodeControllerPermitAllTest {
private String readOnlyAuthorization;
@BeforeAll
- public static void setUp() {
+ public static void initData() {
folderFromClient = Node.builder().name("SomeFolder").userName("myusername").uniqueId("11").build();
}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java
index 65619d5142..26246d4e90 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java
@@ -1,29 +1,19 @@
/**
- * Copyright (C) 2018 European Spallation Source ERIC.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Copyright (C) 2026 European Spallation Source ERIC.
*/
package org.phoebus.service.saveandrestore.web.controllers;
-
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;
+import org.junit.jupiter.api.BeforeEach;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.boot.test.context.SpringBootTest;
+
+import tools.jackson.core.type.TypeReference;
+import tools.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
import org.mockito.stubbing.Answer;
import org.phoebus.applications.saveandrestore.model.Comparison;
@@ -42,12 +32,8 @@
import org.phoebus.service.saveandrestore.web.config.WebSecurityConfig;
import org.phoebus.service.saveandrestore.websocket.WebSocketService;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.ContextHierarchy;
import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
@@ -76,18 +62,25 @@
*
* @author Georg Weiss, European Spallation Source
*/
-@ExtendWith(SpringExtension.class)
-@ContextHierarchy({@ContextConfiguration(classes = {ControllersTestConfig.class, WebSecurityConfig.class})})
+@SpringBootTest(classes = {ControllersTestConfig.class, WebSecurityConfig.class},
+ webEnvironment = SpringBootTest.WebEnvironment.MOCK,
+ properties = "spring.main.allow-bean-definition-overriding=true")
@TestPropertySource(locations = "classpath:test_application.properties")
-@WebMvcTest(NodeController.class)
public class NodeControllerTest {
@Autowired
private NodeDAO nodeDAO;
@Autowired
+ private WebApplicationContext webApplicationContext;
+
private MockMvc mockMvc;
+ @BeforeEach
+ void setUp() {
+ mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).apply(springSecurity()).build();
+ }
+
@Autowired
private WebSocketService webSocketService;
@@ -113,7 +106,7 @@ public class NodeControllerTest {
private String readOnlyAuthorization;
@BeforeAll
- public static void setUp() {
+ public static void initData() {
config1 = Node.builder().nodeType(NodeType.CONFIGURATION).uniqueId("a")
.userName("myusername").build();
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SearchControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SearchControllerTest.java
index 05113d1fb4..9efcb38a61 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SearchControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SearchControllerTest.java
@@ -1,28 +1,19 @@
/*
- * Copyright (C) 2020 European Spallation Source ERIC.
+ * Copyright (C) 2026 European Spallation Source ERIC.
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
package org.phoebus.service.saveandrestore.web.controllers;
+import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;
+import org.junit.jupiter.api.BeforeEach;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.boot.test.context.SpringBootTest;
import co.elastic.clients.elasticsearch.core.SearchRequest;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import tools.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
import org.phoebus.applications.saveandrestore.model.Node;
import org.phoebus.applications.saveandrestore.model.NodeType;
@@ -33,18 +24,12 @@
import org.phoebus.service.saveandrestore.web.config.WebSecurityConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.ContextHierarchy;
import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
import org.springframework.util.LinkedMultiValueMap;
-
-import javax.ws.rs.core.MultivaluedHashMap;
-import javax.ws.rs.core.MultivaluedMap;
+import org.springframework.util.MultiValueMap;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -54,9 +39,9 @@
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
-@ExtendWith(SpringExtension.class)
-@ContextHierarchy({@ContextConfiguration(classes = {ControllersTestConfig.class, WebSecurityConfig.class})})
-@WebMvcTest(SearchController.class)
+@SpringBootTest(classes = {ControllersTestConfig.class, WebSecurityConfig.class},
+ webEnvironment = SpringBootTest.WebEnvironment.MOCK,
+ properties = "spring.main.allow-bean-definition-overriding=true")
@TestPropertySource(locations = "classpath:test_application.properties")
public class SearchControllerTest {
@@ -64,8 +49,15 @@ public class SearchControllerTest {
private NodeDAO nodeDAO;
@Autowired
+ private WebApplicationContext webApplicationContext;
+
private MockMvc mockMvc;
+ @BeforeEach
+ void setUp() {
+ mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).apply(springSecurity()).build();
+ }
+
@Autowired
private ObjectMapper objectMapper;
@@ -96,7 +88,7 @@ public void testSearch() throws Exception {
@Test
public void testSearchForPVs() {
- MultivaluedMap