Skip to content

refactored logging and unit tests #29

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.

Sign up for GitHub

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

Merged
memurats merged 1 commit into from
Feb 21, 2025
Merged

refactored logging and unit tests #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions lib/Event/UserAccountChangeListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,21 @@
namespace OCA\NextMagentaCloudProvisioning\Event;

use OCA\NextMagentaCloudProvisioning\Rules\UserAccountRules;

use OCA\UserOIDC\Event\UserAccountChangeEvent;
use OCP\EventDispatcher\Event;

use OCP\EventDispatcher\IEventListener;

use OCP\ILogger;
use Psr\Log\LoggerInterface;

class UserAccountChangeListener implements IEventListener {

/** @var ILogger */
/** @var LoggerInterface */
private $logger;

/** @var UserAccountRules */
private $accountRules;


public function __construct(ILogger $logger,
public function __construct(LoggerInterface $logger,
UserAccountRules $accountRules) {
$this->logger = $logger;
$this->accountRules = $accountRules;
Expand Down
9 changes: 3 additions & 6 deletions lib/Event/UserAttributeListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,15 @@

use OCA\NextMagentaCloudProvisioning\Rules\DisplaynameRules;
use OCA\NextMagentaCloudProvisioning\Rules\TariffRules;

use OCA\UserOIDC\Event\AttributeMappedEvent;
use OCA\UserOIDC\Service\ProviderService;

use OCP\EventDispatcher\Event;

use OCP\EventDispatcher\IEventListener;
use OCP\ILogger;
use Psr\Log\LoggerInterface;

class UserAttributeListener implements IEventListener {

/** @var ILogger */
/** @var LoggerInterface */
private $logger;

/** @var TariffRules */
Expand All @@ -25,7 +22,7 @@ class UserAttributeListener implements IEventListener {
private $displaynameRules;


public function __construct(ILogger $logger,
public function __construct(LoggerInterface $logger,
TariffRules $tariffRules,
DisplaynameRules $displaynameRules) {
$this->logger = $logger;
Expand Down
9 changes: 5 additions & 4 deletions lib/Rules/UserAccountRules.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
use OCA\UserOIDC\Db\ProviderMapper;
use OCA\UserOIDC\Db\User;
use OCP\IConfig;
use OCP\ILogger;
use OCP\IUser;
use OCP\IUserManager;
use Psr\Log\LoggerInterface;

class UserAccountRules {

/** @var ILogger */
/** @var LoggerInterface */
private $logger;

/** @var IConfig */
Expand All @@ -28,7 +28,7 @@ class UserAccountRules {
private $oidcProviderMapper;

public function __construct(IConfig $config,
ILogger $logger,
LoggerInterface $logger,
NmcUserService $nmcUserService,
IUserManager $userManager,
ProviderMapper $oidcProviderMapper) {
Expand Down Expand Up @@ -139,7 +139,8 @@ public function deriveAccountState(string $uid, ?string $displayname, ?string $m
'slup_test_account_name' => '-test',
'slup_test_account_explode' => '@'
]);
if ($user = $this->nmcUserService->userExists($providerName, $uid, true)) {
$user = $this->nmcUserService->userExists($providerName, $uid, true);
if ($user instanceof OCA\UserOIDC\Db\User || $user instanceof OCP\IUser) {
$this->logger->info("PROV {$uid}: Modify existing");
return $this->deriveExistingAccountState($user, $displayname, $mainEmail, $quota, $claims, $providerName);
} elseif ($create || $config['slup_test_account_check'] &&
Expand Down
32 changes: 4 additions & 28 deletions lib/User/NmcUserService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@
use OCP\AppFramework\Db\MultipleObjectsReturnedException;
use OCP\IConfig;
use OCP\IGroupManager;
use OCP\ILogger;
use OCP\IServerContainer;
use OCP\IUser;
use OCP\IUserManager;
use OCP\Security\ISecureRandom;
use Psr\Log\LoggerInterface;

// classes from user_oidc app

Expand All @@ -29,10 +28,7 @@ class NmcUserService {
/** @var IAccountManager */
private $accountManager;

/** @var IServerContainer */
private $serverc;

/** @var ILogger */
/** @var LoggerInterface */
private $logger;

/** @var IConfig */
Expand All @@ -56,16 +52,14 @@ class NmcUserService {

public function __construct(IUserManager $userManager,
IAccountManager $accountManager,
IServerContainer $serverContainer,
ILogger $logger,
LoggerInterface $logger,
IConfig $config,
UserMapper $oidcUserMapper,
ProviderMapper $oidcProviderMapper,
IGroupManager $groupManager) {
$this->groupTariffMapping = new GroupTariffMapping($config);
$this->userManager = $userManager;
$this->accountManager = $accountManager;
$this->serverc = $serverContainer;
$this->logger = $logger;
$this->config = $config;
$this->oidcUserMapper = $oidcUserMapper;
Expand Down Expand Up @@ -139,7 +133,7 @@ public function userExists(string $provider, string $username, bool $returnUser

return true;
} catch (NotFoundException $eNotFound) {
return false;
return $returnUser ? null : false;
}
}

Expand Down Expand Up @@ -298,24 +292,6 @@ public function create(string $provider,
$this->logger->info("UserID: ".$oidcUser->getUserId());
$this->createAccountUser($user, $email, $quota, $enabled);

/* try {
$this->logger->debug("PROV folder");
$this->serverc->get('UserFolder')->create($user->getUID());
$userFolder = $this->serverc->getUserFolder($user->getUID());
\OC::$server->getLogger()->debug('nmcuser_oidc: User folder created "' . $user->getUID() . '", exists=' . ($this->serverc->getRootFolder()->nodeExists('/' . $user->getUID() . '/files') ? 'true' : 'false'), ['app' => 'debug_create']);

// Write a temporary file to the user home to make sure it is properly setup
// FIXME: Remove once the issue with the missing user directory on concurrent webdav requests are sorted out
$file = $userFolder->newFile('.userCreateTemp');
$file->delete();

// copy skeleton
\OC_Util::copySkeleton($user->getUID(), $userFolder);
} catch (NotPermittedException $ex) {
\OC::$server->getLogger()->logException($ex, ['app' => 'nmcuser_oidc']);
throw new ForbiddenException("Newly created user cannot init home folder. Reason:\n" . $ex->getMessage());
}*/

return [
'id' => $oidcUser->getUserId()
];
Expand Down
6 changes: 0 additions & 6 deletions tests/integration/UserDeletionDbTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,9 @@
use OCA\NextMagentaCloudProvisioning\User\NmcUserService;
use OCA\UserOIDC\Db\ProviderMapper;
use OCA\UserOIDC\Db\UserMapper;


use OCP\Accounts\IAccountManager;

use OCP\IConfig;
use OCP\ILogger;

use OCP\IServerContainer;
use OCP\IUserManager;

class UserDeletionDbTest extends StackedCleanupTestCase {
Expand All @@ -40,7 +35,6 @@ public function setUp(): void {
$this->userServiceMock = $this->getMockBuilder(NmcUserService::class)
->setConstructorArgs([ $this->app->getContainer()->get(IUserManager::class),
$this->app->getContainer()->get(IAccountManager::class),
$this->app->getContainer()->get(IServerContainer::class),
$this->config,
$this->app->getContainer()->get(UserMapper::class),
$this->app->getContainer()->get(ProviderMapper::class)])
Expand Down
8 changes: 2 additions & 6 deletions tests/unit/AttributeMappedDisplaynameTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,14 @@
namespace OCA\NextMagentaCloudProvisioning\UnitTest;

use OCA\NextMagentaCloudProvisioning\AppInfo\Application;

use OCA\NextMagentaCloudProvisioning\Event\UserAttributeListener;
use OCA\NextMagentaCloudProvisioning\Rules\DisplaynameRules;

use OCA\NextMagentaCloudProvisioning\Rules\TariffRules;
use OCA\UserOIDC\Event\AttributeMappedEvent;
use OCA\UserOIDC\Service\ProviderService;

use OCP\AppFramework\App;
use OCP\ILogger;

use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

class AttributeMappedDisplaynameTest extends TestCase {
public const DEMO_CLAIM = <<<JSON
Expand All @@ -40,7 +36,7 @@ class AttributeMappedDisplaynameTest extends TestCase {
public function setUp(): void {
parent::setUp();
$app = new App(Application::APP_ID);
$this->listener = new UserAttributeListener($app->getContainer()->get(ILogger::class),
$this->listener = new UserAttributeListener($app->getContainer()->get(LoggerInterface::class),
$app->getContainer()->get(TariffRules::class),
$app->getContainer()->get(DisplaynameRules::class));

Expand Down
8 changes: 2 additions & 6 deletions tests/unit/AttributeMappedQuotaTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,14 @@
namespace OCA\NextMagentaCloudProvisioning\UnitTest;

use OCA\NextMagentaCloudProvisioning\AppInfo\Application;

use OCA\NextMagentaCloudProvisioning\Event\UserAttributeListener;
use OCA\NextMagentaCloudProvisioning\Rules\DisplaynameRules;

use OCA\NextMagentaCloudProvisioning\Rules\TariffRules;
use OCA\UserOIDC\Event\AttributeMappedEvent;
use OCA\UserOIDC\Service\ProviderService;

use OCP\AppFramework\App;
use OCP\ILogger;

use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

class AttributeMappedQuotaTest extends TestCase {
public const DEMO_CLAIM = <<<JSON
Expand All @@ -40,7 +36,7 @@ class AttributeMappedQuotaTest extends TestCase {
public function setUp(): void {
parent::setUp();
$app = new App(Application::APP_ID);
$this->listener = new UserAttributeListener($app->getContainer()->get(ILogger::class),
$this->listener = new UserAttributeListener($app->getContainer()->get(LoggerInterface::class),
$app->getContainer()->get(TariffRules::class),
$app->getContainer()->get(DisplaynameRules::class));
}
Expand Down
Loading