-
Notifications
You must be signed in to change notification settings - Fork 288
N°9597 - Switch environment to a build environment must not be available #925
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
Lenaick
wants to merge
2
commits into
develop
Choose a base branch
from
issue/9597-add-exception-when-switch-on-build-env
base: develop
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| <?php | ||
|
|
||
| namespace Combodo\iTop\Service\Startup; | ||
|
|
||
| use Combodo\iTop\Application\Helper\Session; | ||
| use CoreException; | ||
| use IssueLog; | ||
|
|
||
| class StartupService | ||
| { | ||
| /** | ||
| * @param string|null $sSwitchEnv | ||
| * @param bool $bAllowCache - whether to allow cache or not (will be set to false if the environment is switched) | ||
| * | ||
| * @return string | ||
| * @throws CoreException | ||
| */ | ||
| public function SetItopEnvironment(?string $sSwitchEnv, bool &$bAllowCache): string | ||
| { | ||
| if ($this->IsBuildEnvironment($sSwitchEnv)) { | ||
| $oException = new CoreException("Switching to environment '$sSwitchEnv' is not allowed since it is a build environment"); | ||
| IssueLog::Exception("Trying to switch to environment '$sSwitchEnv' is not allowed since it is a build environment", $oException); | ||
| throw $oException; | ||
| } | ||
|
|
||
| if ( | ||
| ($sSwitchEnv != null) | ||
| && file_exists(APPCONF.$sSwitchEnv.'/'.ITOP_CONFIG_FILE) | ||
| && (Session::Get('itop_env') !== $sSwitchEnv) | ||
| ) { | ||
| Session::Set('itop_env', $sSwitchEnv); | ||
| $sEnv = $sSwitchEnv; | ||
| $bAllowCache = false; | ||
| // Reset the opcache since otherwise the PHP "model" files may still be cached !! | ||
| if (function_exists('opcache_reset')) { | ||
| // Zend opcode cache | ||
| opcache_reset(); | ||
| } | ||
| if (function_exists('apc_clear_cache')) { | ||
| // APC(u) cache | ||
| apc_clear_cache(); | ||
| } | ||
| // TODO: reset the credentials as well ?? | ||
| } elseif (Session::IsSet('itop_env')) { | ||
| $sEnv = Session::Get('itop_env'); | ||
| } else { | ||
| $sEnv = ITOP_DEFAULT_ENV; | ||
| Session::Set('itop_env', ITOP_DEFAULT_ENV); | ||
| } | ||
|
|
||
| return $sEnv; | ||
| } | ||
|
|
||
| public function IsBuildEnvironment(?string $sEnv): bool | ||
| { | ||
| return $sEnv != null && str_ends_with($sEnv, '-build'); | ||
| } | ||
| } | ||
50 changes: 50 additions & 0 deletions
50
tests/php-unit-tests/unitary-tests/sources/Service/Startup/StartupServiceTest.php
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,50 @@ | ||
| <?php | ||
|
|
||
| namespace Service\Startup; | ||
|
|
||
| use Combodo\iTop\Service\Startup\StartupService; | ||
| use Combodo\iTop\Test\UnitTest\ItopTestCase; | ||
| use CoreException; | ||
|
|
||
| class StartupServiceTest extends ItopTestCase | ||
| { | ||
| private StartupService $oStartupService; | ||
|
|
||
| protected function setUp(): void | ||
| { | ||
| parent::setUp(); | ||
| $this->RequireOnceItopFile('application/utils.inc.php'); | ||
| $this->oStartupService = new StartupService(); | ||
| } | ||
|
|
||
| public function testSetItopEnvironmentUsesDefaultWhenEnvironmentIsNull(): void | ||
| { | ||
| $bAllowCache = true; | ||
| $sEnv = $this->oStartupService->SetItopEnvironment(null, $bAllowCache); | ||
| $this->assertEquals(ITOP_DEFAULT_ENV, $sEnv); | ||
| $this->assertTrue($bAllowCache); | ||
| } | ||
|
|
||
| public function testSetItopEnvironmentWithValidEnvironment(): void | ||
| { | ||
| $bAllowCache = true; | ||
| $sEnv = $this->oStartupService->SetItopEnvironment('test', $bAllowCache); | ||
| $this->assertEquals('test', $sEnv); | ||
| $this->assertFalse($bAllowCache); | ||
| } | ||
|
|
||
| public function testSetItopEnvironmentThrowsForBuildEnvironment() | ||
| { | ||
| $bAllowCache = true; | ||
| $this->expectException(CoreException::class); | ||
| $this->expectExceptionMessage("Switching to environment 'test-build' is not allowed since it is a build environment"); | ||
| $this->oStartupService->SetItopEnvironment('test-build', $bAllowCache); | ||
| } | ||
|
|
||
| public function testIsBuildEnvironment() | ||
| { | ||
| $this->assertTrue($this->oStartupService->IsBuildEnvironment('test-build')); | ||
| $this->assertFalse($this->oStartupService->IsBuildEnvironment('test')); | ||
| $this->assertFalse($this->oStartupService->IsBuildEnvironment(null)); | ||
| } | ||
| } |
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.
switch_env, but setup writes the build environment into$_SESSION['itop_env']duringRunTimeEnvironment::InitDataModel(). On the next normal application request with noswitch_env, this branch returnsproduction-buildfrom the session andstartup.inc.phpstartsMetaModelfromconf/production-build/config-itop.php, so the build environment remains selectable through existing session state.