Skip to content

Commit

Permalink
chore(seeder): add Member and User seeders
Browse files Browse the repository at this point in the history
The data fixtures can be loaded into the database using the
`application:fixtures:load` command. All existing records are `TRUNCATE`d from
the database to ensure a clean start.

This also fixes some inconsistencies in the (sub)decision model with GEWISDB,
somehow the possibility for these to be `null` got lost somewhere (and fixes for
initialisation of `Collection`s).

---

Unfortunately, adding the data fixtures for (sub)decisions has proved to be
quite difficult. As such, these have been removed. The WIP can be found in
#1913.

There is an issue with the "hydration" of the entities when they are added to
the database. I have not seen this issue in GEWISDB, but the cause appears to be
the usage of `BackedEnum`s as part of a composite key (which forms the
foundation for our (sub)decision entities and relations).

Either the enum cannot be cast to string while being saved to the database. Or
when using custom mapping types (see the PR mentioned) above the value cannot
be properly restored from the database. The latter can then also be fixed with
another patch for ORM (see GEWIS/orm@8031547),
however, this may break other things. This patch can probably also be applied in
reverse, such that we do not need the custom mapping types. However, this has
not (yet) been tested.

As such, this has to be investigated more and potentially a bug report must be
submitted to Doctrine ORM to get this fixed.
  • Loading branch information
tomudding committed Nov 13, 2024
1 parent e997d06 commit 5eb9f74
Show file tree
Hide file tree
Showing 13 changed files with 540 additions and 8 deletions.
9 changes: 6 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ rundev: builddev
@make replenish
@docker compose exec web rm -rf data/cache/module-config-cache.application.config.cache.php

migrate: replenish
@docker compose exec -it web ./orm migrations:migrate

migration-list: replenish
@docker compose exec -T web ./orm migrations:list

migration-diff: replenish
@docker compose exec -T web ./orm migrations:diff
@docker cp "$(shell docker compose ps -q web)":/code/module/Application/migrations ./module/Application/migrations

migration-migrate: replenish
@docker compose exec -it web ./orm migrations:migrate

migration-up: replenish migration-list
@read -p "Enter the migration version to execute (e.g., Application\\Migrations\\Version20241020212355 -- note escaping the backslashes is required): " version; \
docker compose exec -it web ./orm migrations:execute --up $$version
Expand All @@ -60,6 +60,9 @@ migration-down: replenish migration-list
@read -p "Enter the migration version to down (e.g., Application\\Migrations\\Version20241020212355 -- note escaping the backslashes is required): " version; \
docker compose exec -it web ./orm migrations:execute --down $$version

seed: replenish
@docker compose exec -T web ./web application:fixtures:load

exec:
docker compose exec -it web $(cmd)

Expand Down
6 changes: 6 additions & 0 deletions module/Application/config/module.config.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Application;

use Application\Command\LoadFixtures;
use Application\Controller\Factory\IndexControllerFactory;
use Application\Controller\IndexController;
use Application\View\Helper\BootstrapElementError;
Expand Down Expand Up @@ -148,6 +149,11 @@
'message_separator_string' => '</li><li>',
],
],
'laminas-cli' => [
'commands' => [
'application:fixtures:load' => LoadFixtures::class,
],
],
'doctrine' => [
'driver' => [
__NAMESPACE__ . '_driver' => [
Expand Down
27 changes: 27 additions & 0 deletions module/Application/src/Command/Factory/LoadFixturesFactory.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

declare(strict_types=1);

namespace Application\Command\Factory;

use Application\Command\LoadFixtures;
use Doctrine\ORM\EntityManager;
use Laminas\ServiceManager\Factory\FactoryInterface;
use Psr\Container\ContainerInterface;

class LoadFixturesFactory implements FactoryInterface
{
/**
* @param string $requestedName
*/
public function __invoke(
ContainerInterface $container,
$requestedName,
?array $options = null,
): LoadFixtures {
/** @var EntityManager $entityManager */
$entityManager = $container->get('doctrine.entitymanager.orm_default');

return new LoadFixtures($entityManager);
}
}
68 changes: 68 additions & 0 deletions module/Application/src/Command/LoadFixtures.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?php

declare(strict_types=1);

namespace Application\Command;

use Doctrine\Common\DataFixtures\Executor\ORMExecutor;
use Doctrine\Common\DataFixtures\Loader;
use Doctrine\Common\DataFixtures\Purger\ORMPurger;
use Doctrine\ORM\EntityManager;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Throwable;

#[AsCommand(
name: 'application:fixtures:load',
description: 'Seed the database with data fixtures.',
)]
class LoadFixtures extends Command
{
private const array FIXTURES = [
// './module/Activity/test/Seeder',
// './module/Company/test/Seeder',
'./module/Decision/test/Seeder',
// './module/Education/test/Seeder',
// './module/Frontpage/test/Seeder',
// './module/Photo/test/Seeder',
'./module/User/test/Seeder',
];

public function __construct(private readonly EntityManager $entityManager)
{
parent::__construct();
}

protected function execute(
InputInterface $input,
OutputInterface $output,
): int {
$loader = new Loader();
$purger = new ORMPurger();
$purger->setPurgeMode(ORMPurger::PURGE_MODE_TRUNCATE);
$executor = new ORMExecutor($this->entityManager, $purger);

foreach ($this::FIXTURES as $fixture) {
$loader->loadFromDirectory($fixture);
}

$output->writeln('<info>Loading fixtures into the database...</info>');

$connection = $this->entityManager->getConnection();
try {
// Temporarily disable FK constraint checks. This is necessary because large parts of our database do not have

Check warning on line 55 in module/Application/src/Command/LoadFixtures.php

View workflow job for this annotation

GitHub Actions / php-codesniffer / PHP_CodeSniffer (8.3)

Line exceeds 120 characters; contains 122 characters
// explicit CASCADEs set to prevent data loss when syncing with ReportDB (GEWISDB).
// The try-catch is necessary to hide some error messages (because the executeStatement).
$connection->executeStatement('SET FOREIGN_KEY_CHECKS = 0');
$executor->execute($loader->getFixtures());
$connection->executeStatement('SET FOREIGN_KEY_CHECKS = 1');
} catch (Throwable) {
}

$output->writeln('<info>Loaded fixtures!</info>');

return Command::SUCCESS;
}
}
3 changes: 3 additions & 0 deletions module/Application/src/Module.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

namespace Application;

use Application\Command\Factory\LoadFixturesFactory as LoadFixturesCommandFactory;
use Application\Command\LoadFixtures as LoadFixturesCommand;
use Application\Extensions\CommonMark\CompanyImage\CompanyImageExtension;
use Application\Extensions\CommonMark\NoImage\NoImageExtension;
use Application\Extensions\CommonMark\VideoIframe\VideoIframeExtension;
Expand Down Expand Up @@ -266,6 +268,7 @@ public function generateSignature(

return new UrlBuilder($config['glide']['base_url'], $signature);
},
LoadFixturesCommand::class => LoadFixturesCommandFactory::class,
],
];
}
Expand Down
4 changes: 2 additions & 2 deletions module/Decision/src/Model/AssociationYear.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ class AssociationYear
/**
* A GEWIS association year starts 01-07.
*/
public const ASSOCIATION_YEAR_START_MONTH = 7;
public const ASSOCIATION_YEAR_START_DAY = 1;
public const int ASSOCIATION_YEAR_START_MONTH = 7;
public const int ASSOCIATION_YEAR_START_DAY = 1;

/** @var int the first calendar year of the association year */
protected int $firstYear;
Expand Down
9 changes: 8 additions & 1 deletion module/Decision/src/Model/Decision.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use Decision\Model\Enums\MeetingTypes;
use Decision\Model\SubDecision\Annulment;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\Entity;
Expand Down Expand Up @@ -52,6 +53,7 @@ class Decision
enumType: MeetingTypes::class,
)]
protected MeetingTypes $meeting_type;

/**
* Meeting number.
*
Expand Down Expand Up @@ -103,7 +105,12 @@ enumType: MeetingTypes::class,
targetEntity: Annulment::class,
mappedBy: 'target',
)]
protected Annulment $annulledBy;
protected ?Annulment $annulledBy = null;

public function __construct()
{
$this->subdecisions = new ArrayCollection();
}

/**
* Set the meeting.
Expand Down
4 changes: 2 additions & 2 deletions module/Decision/src/Model/SubDecision/Installation.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class Installation extends FoundationReference
targetEntity: Discharge::class,
mappedBy: 'installation',
)]
protected Discharge $discharge;
protected ?Discharge $discharge = null;

/**
* The organmember reference.
Expand Down Expand Up @@ -114,7 +114,7 @@ public function getReappointments(): Collection
/**
* Get the discharge, if it exists.
*/
public function getDischarge(): Discharge
public function getDischarge(): ?Discharge
{
return $this->discharge;
}
Expand Down
44 changes: 44 additions & 0 deletions module/Decision/test/Seeder/MeetingFixture.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

declare(strict_types=1);

namespace DecisionTest\Seeder;

use DateTime;
use Decision\Model\AssociationYear;
use Decision\Model\Enums\MeetingTypes;
use Decision\Model\Meeting;
use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Persistence\ObjectManager;

use function range;

class MeetingFixture extends AbstractFixture
{
public function load(ObjectManager $manager): void
{
$today = new DateTime();

foreach (MeetingTypes::cases() as $meetingType) {
foreach (range(0, 3) as $meetingNumber) {
$meeting = new Meeting();
$meeting->setType($meetingType);
$meeting->setNumber($meetingNumber);

// 2 meetings in the past, 1 today, and 1 in the future.
if (3 > $meetingNumber) {
$meetingDate = (clone $today)->modify('-' . (2 - $meetingNumber) . ' days');
} else {
$meetingDate = AssociationYear::fromDate($today)->getEndDate();
}

$meeting->setDate($meetingDate);

$manager->persist($meeting);
$this->addReference('meeting-' . $meetingType->value . '-' . $meetingNumber, $meeting);
}

$manager->flush();
}
}
}
Loading

0 comments on commit 5eb9f74

Please sign in to comment.