-
Notifications
You must be signed in to change notification settings - Fork 81
Added DotEnvConditionChecker #8276
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
Andrii-Danylenko
wants to merge
6
commits into
dev
Choose a base branch
from
feature/implement-dotenv-checker-to-prevent-unexpected-behaviour-
base: dev
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
6 commits
Select commit
Hold shift + click to select a range
484f0d0
Added DotEnvConditionChecker to detect the presence of a dotenv file …
Andrii-Danylenko 6ba65d6
Fixed checkstyle
Andrii-Danylenko 40ac95b
Added caching and tests
Andrii-Danylenko fe17f74
Added caching and tests
Andrii-Danylenko d9b34ca
Added caching and tests
Andrii-Danylenko fc48c5f
Fixed test
Andrii-Danylenko 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
22 changes: 22 additions & 0 deletions
22
service/src/main/java/greencity/config/dotenv/DotEnvConditionChecker.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,22 @@ | ||
| package greencity.config.dotenv; | ||
|
|
||
| import greencity.constant.AppConstant; | ||
| import java.io.File; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
|
|
||
| public class DotEnvConditionChecker { | ||
| private static Boolean cachedValue = null; | ||
|
|
||
| public static boolean isEnabled() { | ||
| if (cachedValue == null) { | ||
| try { | ||
| cachedValue = Files | ||
| .exists(Paths.get(System.getProperty("user.dir") + File.separator + AppConstant.DOTENV_FILENAME)); | ||
| } catch (SecurityException e) { | ||
| cachedValue = false; | ||
| } | ||
| } | ||
| return cachedValue; | ||
| } | ||
| } | ||
8 changes: 6 additions & 2 deletions
8
...n/java/greencity/config/DotenvConfig.java → ...greencity/config/dotenv/DotenvConfig.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
90 changes: 90 additions & 0 deletions
90
service/src/test/java/greencity/utils/dotenv/DotEnvConditionCheckerTest.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,90 @@ | ||
| package greencity.utils.dotenv; | ||
|
|
||
| import greencity.config.dotenv.DotEnvConditionChecker; | ||
| import org.junit.jupiter.api.AfterAll; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.mockito.MockedStatic; | ||
| import org.mockito.Mockito; | ||
| import java.lang.reflect.Field; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.ArgumentMatchers.anyString; | ||
| import static org.mockito.Mockito.times; | ||
|
|
||
| class DotEnvConditionCheckerTest { | ||
| private static MockedStatic<Paths> mockedPaths; | ||
| private static MockedStatic<Files> mockedFiles; | ||
|
|
||
| @BeforeEach | ||
| void setUp() throws NoSuchFieldException, IllegalAccessException { | ||
| Field cachedValueField = DotEnvConditionChecker.class.getDeclaredField("cachedValue"); | ||
| cachedValueField.setAccessible(true); | ||
| cachedValueField.set(null, null); | ||
| mockedPaths.clearInvocations(); | ||
| mockedFiles.clearInvocations(); | ||
| } | ||
|
|
||
| @BeforeAll | ||
| public static void init() { | ||
| mockedFiles = Mockito.mockStatic(Files.class); | ||
| mockedPaths = Mockito.mockStatic(Paths.class); | ||
| } | ||
|
|
||
| @AfterAll | ||
| public static void cleanup() { | ||
| mockedPaths.close(); | ||
| mockedFiles.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void checkIsEnabledReturnsTrueIfPathIsValid() { | ||
| Path paths = Mockito.mock(Path.class); | ||
|
|
||
| mockedPaths.when(() -> Paths.get(anyString())).thenReturn(paths); | ||
| mockedFiles.when(() -> Files.exists(paths)).thenReturn(true); | ||
|
|
||
| assertTrue(DotEnvConditionChecker.isEnabled()); | ||
| mockedPaths.verify(() -> Paths.get(anyString()), times(1)); | ||
| mockedFiles.verify(() -> Files.exists(paths), times(1)); | ||
|
|
||
| } | ||
|
|
||
| @Test | ||
| public void checkIsEnabledReturnsFalseIfPathNotExistsTest() { | ||
| Path paths = Mockito.mock(Path.class); | ||
|
|
||
| mockedPaths.when(() -> Paths.get(anyString())).thenReturn(paths); | ||
| mockedFiles.when(() -> Files.exists(paths)).thenReturn(false); | ||
|
|
||
| assertFalse(DotEnvConditionChecker.isEnabled()); | ||
| mockedPaths.verify(() -> Paths.get(anyString()), times(1)); | ||
| mockedFiles.verify(() -> Files.exists(paths), times(1)); | ||
| } | ||
|
|
||
| @Test | ||
| public void checkIsFalseIfPathIsProtectedTest() { | ||
| mockedPaths.when(() -> Paths.get(anyString())).thenThrow(SecurityException.class); | ||
|
|
||
| assertFalse(DotEnvConditionChecker.isEnabled()); | ||
| mockedPaths.verify(() -> Paths.get(anyString()), times(1)); | ||
| mockedFiles.verify(() -> Files.exists(any(Path.class)), times(0)); | ||
| } | ||
|
|
||
| @Test | ||
| public void checkIsNoInvocationIfAlreadyCalculatedTest() throws NoSuchFieldException, IllegalAccessException { | ||
| Field cachedValueField = DotEnvConditionChecker.class.getDeclaredField("cachedValue"); | ||
| cachedValueField.setAccessible(true); | ||
| cachedValueField.set(null, false); | ||
|
|
||
| assertFalse(DotEnvConditionChecker.isEnabled()); | ||
| mockedPaths.verify(() -> Paths.get(anyString()), times(0)); | ||
| mockedFiles.verify(() -> Files.exists(any(Path.class)), times(0)); | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.