-
Notifications
You must be signed in to change notification settings - Fork 8.5k
fix: resolve config refresh failure with spring.config.import on 2025.0.x #4335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wushiyuanmaimob
wants to merge
4
commits into
alibaba:2025.0.x
Choose a base branch
from
wushiyuanmaimob:fix/nacos-config-refresh-mismatch-4331
base: 2025.0.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f639f73
test: add regression test for config refresh with ConfigData path
wushiyuanmaimob 3a7da96
fix: resolve config refresh failure with spring.config.import on 2025…
wushiyuanmaimob 05418be
test: fix NacosPropertySourceRefreshListener test setup
wushiyuanmaimob f4613ed
test: fix assertion type mismatch and name lookup in refresh listener…
wushiyuanmaimob File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
...src/test/java/com.alibaba.cloud.nacos/refresh/NacosPropertySourceRefreshListenerTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * Copyright 2013-2023 the original author or authors. | ||
| * | ||
| * Licensed 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 | ||
| * | ||
| * https://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 com.alibaba.cloud.nacos.refresh; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Date; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import com.alibaba.cloud.nacos.NacosConfigManager; | ||
| import com.alibaba.cloud.nacos.NacosConfigProperties; | ||
| import com.alibaba.cloud.nacos.client.NacosPropertySource; | ||
| import com.alibaba.nacos.api.config.ConfigService; | ||
| import com.alibaba.nacos.api.exception.NacosException; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import org.springframework.boot.context.event.ApplicationReadyEvent; | ||
| import org.springframework.context.ConfigurableApplicationContext; | ||
| import org.springframework.core.env.ConfigurableEnvironment; | ||
| import org.springframework.core.env.MapPropertySource; | ||
| import org.springframework.core.env.MutablePropertySources; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| /** | ||
| * Test for {@link NacosPropertySourceRefreshListener}. | ||
| * | ||
| * @author wushiyuan | ||
| */ | ||
| public class NacosPropertySourceRefreshListenerTest { | ||
|
|
||
| private NacosPropertySourceRefreshListener listener; | ||
| private ConfigurableApplicationContext applicationContext; | ||
| private ConfigurableEnvironment environment; | ||
| private MutablePropertySources propertySources; | ||
| private NacosConfigManager nacosConfigManager; | ||
| private ConfigService configService; | ||
|
|
||
| @BeforeEach | ||
| public void setUp() throws NacosException { | ||
| nacosConfigManager = mock(NacosConfigManager.class); | ||
| configService = mock(ConfigService.class); | ||
| NacosConfigProperties properties = new NacosConfigProperties(); | ||
| properties.setTimeout(3000); | ||
|
|
||
| when(nacosConfigManager.getConfigService()).thenReturn(configService); | ||
| when(nacosConfigManager.getNacosConfigProperties()).thenReturn(properties); | ||
|
|
||
| applicationContext = mock(ConfigurableApplicationContext.class); | ||
| environment = mock(ConfigurableEnvironment.class); | ||
| propertySources = new MutablePropertySources(); | ||
|
|
||
| when(applicationContext.getEnvironment()).thenReturn(environment); | ||
| when(environment.getPropertySources()).thenReturn(propertySources); | ||
| when(applicationContext.containsBean("nacosConfigSpringCloudRefreshEventListener")).thenReturn(false); | ||
|
|
||
| listener = new NacosPropertySourceRefreshListener(nacosConfigManager); | ||
| listener.setApplicationContext(applicationContext); | ||
| } | ||
|
|
||
| /** | ||
| * Test refresh with ConfigData path naming (group@dataId). | ||
| * This test verifies that the listener can locate a NacosPropertySource | ||
| * registered under the ConfigData naming convention and refresh it. | ||
| */ | ||
| @Test | ||
| public void testRefreshWithConfigDataPathNaming() throws NacosException { | ||
| // Given: a property source with ConfigData path naming (group@dataId) | ||
| String group = "DEFAULT_GROUP"; | ||
| String dataId = "test-config.yml"; | ||
| String configDataName = group + "@" + dataId; // ConfigData path uses group@dataId | ||
|
|
||
| Map<String, Object> initialData = new HashMap<>(); | ||
| initialData.put("app.name", "old-value"); | ||
| MapPropertySource innerSource = new MapPropertySource(configDataName, initialData); | ||
| NacosPropertySource nacosPropertySource = new NacosPropertySource( | ||
| Collections.singletonList(innerSource), group, dataId, new Date(), true, "yml"); | ||
|
|
||
| propertySources.addLast(nacosPropertySource); | ||
|
|
||
| // Mark app as ready | ||
| listener.handle(mock(ApplicationReadyEvent.class)); | ||
|
|
||
| // When: config changes in Nacos | ||
| String newConfig = "app:\n name: new-value"; | ||
| when(configService.getConfig(dataId, group, 3000L)).thenReturn(newConfig); | ||
|
|
||
| NacosConfigRefreshEvent event = new NacosConfigRefreshEvent(this, null, "test refresh"); | ||
| event.setDataId(dataId); | ||
| event.setGroup(group); | ||
|
|
||
| listener.handle(event); | ||
|
|
||
| // Then: the listener should have found the source via configDataName fallback | ||
| // and replaced it. After replacement, the new NacosPropertySource uses | ||
| // the standard "dataId,group" naming from its constructor. | ||
| String standardName = dataId + "," + group; | ||
| assertThat(propertySources.contains(standardName)).isTrue(); | ||
| Object updatedValue = propertySources.get(standardName).getProperty("app.name"); | ||
| assertThat(updatedValue).isEqualTo("new-value"); | ||
| } | ||
|
|
||
| /** | ||
| * Test refresh with yml file extension. | ||
| * This test verifies that the listener uses the actual file extension | ||
| * from the existing NacosPropertySource instead of hardcoding "properties". | ||
| */ | ||
| @Test | ||
| public void testRefreshWithYmlExtension() throws NacosException { | ||
| // Given: a yml config | ||
| String group = "DEFAULT_GROUP"; | ||
| String dataId = "test-config.yml"; | ||
| String sourceName = dataId + "," + group; // bootstrap path naming | ||
|
|
||
| Map<String, Object> initialData = new HashMap<>(); | ||
| initialData.put("app.port", "8080"); | ||
| MapPropertySource innerSource = new MapPropertySource(sourceName, initialData); | ||
| NacosPropertySource nacosPropertySource = new NacosPropertySource( | ||
| Collections.singletonList(innerSource), group, dataId, new Date(), true, "yml"); | ||
|
|
||
| propertySources.addLast(nacosPropertySource); | ||
|
|
||
| // Mark app as ready | ||
| listener.handle(mock(ApplicationReadyEvent.class)); | ||
|
|
||
| // When: yml config changes in Nacos | ||
| String newYmlConfig = "app:\n port: 9090"; | ||
| when(configService.getConfig(dataId, group, 3000L)).thenReturn(newYmlConfig); | ||
|
|
||
| NacosConfigRefreshEvent event = new NacosConfigRefreshEvent(this, null, "test refresh"); | ||
| event.setDataId(dataId); | ||
| event.setGroup(group); | ||
|
|
||
| listener.handle(event); | ||
|
|
||
| // Then: the yml should be parsed correctly (not as properties) | ||
| assertThat(propertySources.contains(sourceName)).isTrue(); | ||
| Object updatedValue = propertySources.get(sourceName).getProperty("app.port"); | ||
| // YAML parser returns Integer for numeric values | ||
| assertThat(String.valueOf(updatedValue)).isEqualTo("9090"); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on the fix in #4341, it looks like the naming mismatch issue should no longer occur.