Remove old entities, fixtures and tables after migration

Symfony/app/AppKernel.php

@@ -17,7 +17,8 @@ public function registerBundles()
             new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
             new Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle(),
             new Codebender\LibraryBundle\CodebenderLibraryBundle(),
-            new Doctrine\Bundle\FixturesBundle\DoctrineFixturesBundle()
+            new Doctrine\Bundle\FixturesBundle\DoctrineFixturesBundle(),
+            new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle()
         );
 
         if (in_array($this->getEnvironment(), array('dev', 'test'))) {

Symfony/app/DoctrineMigrations/Version20160203104457.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Application\Migrations;
+
+use Doctrine\DBAL\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema;
+
+class Version20160203104457 extends AbstractMigration
+{
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('CREATE TABLE Architecture (id INT AUTO_INCREMENT NOT NULL, name VARCHAR(255) NOT NULL, UNIQUE INDEX name_idx (name), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE Library (id INT AUTO_INCREMENT NOT NULL, name VARCHAR(255) NOT NULL, default_header VARCHAR(255) NOT NULL, folder_name VARCHAR(255) NOT NULL, description VARCHAR(2048) NOT NULL, owner VARCHAR(255) DEFAULT NULL, repo VARCHAR(255) DEFAULT NULL, branch VARCHAR(255) DEFAULT NULL, in_repo_path VARCHAR(255) DEFAULT NULL, notes LONGTEXT DEFAULT NULL, verified TINYINT(1) NOT NULL, active TINYINT(1) NOT NULL, last_commit VARCHAR(255) DEFAULT NULL, url VARCHAR(512) DEFAULT NULL, UNIQUE INDEX header_idx (default_header, folder_name), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE LibraryExample (id INT AUTO_INCREMENT NOT NULL, version_id INT DEFAULT NULL, name VARCHAR(255) NOT NULL, path VARCHAR(255) NOT NULL, boards VARCHAR(2048) DEFAULT NULL, INDEX IDX_3EE4A5D34BBC2705 (version_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE Partner (id INT AUTO_INCREMENT NOT NULL, name VARCHAR(255) NOT NULL, auth_key VARCHAR(255) NOT NULL, UNIQUE INDEX auth_key_idx (auth_key), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE Preference (id INT AUTO_INCREMENT NOT NULL, library_id INT DEFAULT NULL, partner_id INT DEFAULT NULL, version_id INT DEFAULT NULL, INDEX IDX_1234B383FE2541D7 (library_id), INDEX IDX_1234B3839393F8FE (partner_id), INDEX IDX_1234B3834BBC2705 (version_id), UNIQUE INDEX search_idx (library_id, partner_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE Version (id INT AUTO_INCREMENT NOT NULL, library_id INT DEFAULT NULL, version VARCHAR(255) NOT NULL, description VARCHAR(2048) DEFAULT NULL, notes LONGTEXT DEFAULT NULL, source_url VARCHAR(512) DEFAULT NULL, release_commit VARCHAR(255) DEFAULT NULL, folder_name VARCHAR(255) NOT NULL, INDEX IDX_70A1EA5FFE2541D7 (library_id), UNIQUE INDEX folders_idx (library_id, folder_name), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE ArchitectureVersion (version_id INT NOT NULL, architecture_id INT NOT NULL, INDEX IDX_98E4E2F14BBC2705 (version_id), INDEX IDX_98E4E2F173F96878 (architecture_id), PRIMARY KEY(version_id, architecture_id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB');
+        $this->addSql('ALTER TABLE LibraryExample ADD CONSTRAINT FK_3EE4A5D34BBC2705 FOREIGN KEY (version_id) REFERENCES Version (id)');
+        $this->addSql('ALTER TABLE Preference ADD CONSTRAINT FK_1234B383FE2541D7 FOREIGN KEY (library_id) REFERENCES Library (id)');
+        $this->addSql('ALTER TABLE Preference ADD CONSTRAINT FK_1234B3839393F8FE FOREIGN KEY (partner_id) REFERENCES Partner (id)');
+        $this->addSql('ALTER TABLE Preference ADD CONSTRAINT FK_1234B3834BBC2705 FOREIGN KEY (version_id) REFERENCES Version (id)');
+        $this->addSql('ALTER TABLE Version ADD CONSTRAINT FK_70A1EA5FFE2541D7 FOREIGN KEY (library_id) REFERENCES Library (id)');
+        $this->addSql('ALTER TABLE ArchitectureVersion ADD CONSTRAINT FK_98E4E2F14BBC2705 FOREIGN KEY (version_id) REFERENCES Version (id)');
+        $this->addSql('ALTER TABLE ArchitectureVersion ADD CONSTRAINT FK_98E4E2F173F96878 FOREIGN KEY (architecture_id) REFERENCES Architecture (id)');
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE ArchitectureVersion DROP FOREIGN KEY FK_98E4E2F173F96878');
+        $this->addSql('ALTER TABLE Preference DROP FOREIGN KEY FK_1234B383FE2541D7');
+        $this->addSql('ALTER TABLE Version DROP FOREIGN KEY FK_70A1EA5FFE2541D7');
+        $this->addSql('ALTER TABLE Preference DROP FOREIGN KEY FK_1234B3839393F8FE');
+        $this->addSql('ALTER TABLE LibraryExample DROP FOREIGN KEY FK_3EE4A5D34BBC2705');
+        $this->addSql('ALTER TABLE Preference DROP FOREIGN KEY FK_1234B3834BBC2705');
+        $this->addSql('ALTER TABLE ArchitectureVersion DROP FOREIGN KEY FK_98E4E2F14BBC2705');
+        $this->addSql('DROP TABLE Architecture');
+        $this->addSql('DROP TABLE Library');
+        $this->addSql('DROP TABLE LibraryExample');
+        $this->addSql('DROP TABLE Partner');
+        $this->addSql('DROP TABLE Preference');
+        $this->addSql('DROP TABLE Version');
+        $this->addSql('DROP TABLE ArchitectureVersion');
+    }
+}

Symfony/app/DoctrineMigrations/Version20160315080428.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Application\Migrations;
+
+use Doctrine\DBAL\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+class Version20160315080428 extends AbstractMigration
+{
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema)
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE Library ADD latest_version_id INT');
+        $this->addSql('ALTER TABLE Library ADD CONSTRAINT FK_6E3DA1205F67402F FOREIGN KEY (latest_version_id) REFERENCES Version (id)');
+        $this->addSql('CREATE UNIQUE INDEX UNIQ_6E3DA1205F67402F ON Library (latest_version_id)');
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema)
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE Library DROP FOREIGN KEY FK_6E3DA1205F67402F');
+        $this->addSql('DROP INDEX UNIQ_6E3DA1205F67402F ON Library');
+        $this->addSql('ALTER TABLE Library DROP latest_version_id');
+    }
+}

Symfony/app/DoctrineMigrations/Version20160315081844.php

@@ -0,0 +1,270 @@
+<?php
+
+namespace Application\Migrations;
+
+use Codebender\LibraryBundle\Entity\Architecture;
+use Codebender\LibraryBundle\Entity\Example;
+use Codebender\LibraryBundle\Entity\ExternalLibrary;
+use Codebender\LibraryBundle\Entity\Library;
+use Codebender\LibraryBundle\Entity\LibraryExample;
+use Codebender\LibraryBundle\Entity\Partner;
+use Codebender\LibraryBundle\Entity\Preference;
+use Codebender\LibraryBundle\Entity\Version;
+use Codebender\LibraryBundle\Handler\ApiHandler;
+use Doctrine\DBAL\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\ORM\EntityManager;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\SplFileInfo;
+use Symfony\Component\Finder\Finder;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+class Version20160315081844 extends AbstractMigration implements ContainerAwareInterface
+{
+    private $container;
+
+    public function setContainer(ContainerInterface $container = null)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE Library ADD is_built_in TINYINT(1) NOT NULL');
+    }
+
+    public function postUp(Schema $schema)
+    {
+        /* @var EntityManager $entityManager */
+        $entityManager = $this->container->get('doctrine.orm.entity_manager');
+
+        /*
+         * 1. Create the various Arduino architectures
+         */
+        $avrArchitecture = new Architecture();
+        $avrArchitecture->setName('AVR');
+
+        $esp8266Architecture = new Architecture();
+        $esp8266Architecture->setName('ESP8266');
+
+        $edisonArchitecture = new Architecture();
+        $edisonArchitecture->setName('Intel Edison');
+
+        $teensyArchitecture = new Architecture();
+        $teensyArchitecture->setName('Teensy');
+
+        $architectures = [$avrArchitecture, $esp8266Architecture, $edisonArchitecture, $teensyArchitecture];
+        foreach ($architectures as $architecture) {
+            $entityManager->persist($architecture);
+        }
+        $entityManager->flush();
+
+        /*
+         * 2. Migrate existing external libraries and add AVR architecture to them
+         */
+        $externalLibraries = $entityManager->getRepository('CodebenderLibraryBundle:ExternalLibrary')
+            ->findAll();
+        $externalLibraryVersion = 'CB-1';
+        /* @var ExternalLibrary $externalLibrary */
+        foreach ($externalLibraries as $externalLibrary) {
+            $defaultHeader = $externalLibrary->getMachineName();
+            print("Migrating external lib: $defaultHeader\n");
+
+            // Do not migrate the SD external library
+            if ($defaultHeader === 'SD') continue;
+
+            /*
+             * Migrate all the existing attributes
+             */
+            $library = new Library();
+            $library->setName($externalLibrary->getHumanName());
+            $library->setDefaultHeader($externalLibrary->getMachineName());
+            $library->setFolderName($externalLibrary->getMachineName());
+            $library->setDescription($externalLibrary->getDescription());
+            $library->setOwner($externalLibrary->getOwner());
+            $library->setRepo($externalLibrary->getRepo());
+            $library->setBranch($externalLibrary->getBranch());
+            $library->setInRepoPath($externalLibrary->getInRepoPath());
+            $library->setNotes($externalLibrary->getNotes());
+            $library->setVerified($externalLibrary->getVerified());
+            $library->setActive($externalLibrary->getActive());
+            $library->setLastCommit($externalLibrary->getLastCommit());
+            $library->setUrl($externalLibrary->getUrl());
+            $library->setIsBuiltIn(False);
+
+            $version = new Version();
+            $version->setLibrary($library);
+            $version->setVersion($externalLibraryVersion);
+            $version->setDescription($externalLibrary->getDescription());
+            $version->setNotes($externalLibrary->getNotes());
+            $version->setSourceUrl($externalLibrary->getSourceUrl());
+            $version->setFolderName($externalLibraryVersion);
+            $version->addArchitecture($avrArchitecture);
+
+            $examples = $entityManager->getRepository('CodebenderLibraryBundle:Example')
+                ->findBy(['library' => $externalLibrary]);
+            /* @var Example $example */
+            foreach ($examples as $example) {
+                $position = strpos($example->getPath(), '/');
+                $newExamplePath = substr($example->getPath(), $position + 1);
+
+                $libraryExample = new LibraryExample();
+                $libraryExample->setName($example->getName());
+                $libraryExample->setVersion($version);
+                $libraryExample->setBoards($example->getBoards());
+                $libraryExample->setPath($newExamplePath);
+
+                $entityManager->persist($libraryExample);
+            }
+
+            $library->addVersion($version);
+            $library->setLatestVersion($version);
+
+            /*
+             * Persist and move library files
+             */
+            $entityManager->persist($library);
+            $entityManager->persist($version);
+            $this->moveExternalLibraryFiles($defaultHeader, $externalLibraryVersion);
+        }
+        $entityManager->flush();
+
+        /*
+         * 3. Migrate existing built-in libraries as external libraries and add AVR architecture to them
+         */
+        $builtInVersion = '1.0.5';
+        $builtInLibrariesPath = $this->container->getParameter('builtin_libraries') . '/libraries';
+        $finder = new Finder();
+        $finder->depth(0);
+        /* @var SplFileInfo $builtInLibrary */
+        foreach ($finder->in($builtInLibrariesPath) as $builtInLibrary) {
+            /*
+             * Migrate any existing attributes
+             */
+            $defaultHeader = $builtInLibrary->getFilename();
+            print("Migrating built-in lib: $defaultHeader\n");
+
+            $library = new Library();
+            $library->setName($defaultHeader);
+            $library->setDefaultHeader($defaultHeader);
+            $library->setFolderName($defaultHeader);
+            $library->setDescription($defaultHeader . ' v' . $builtInVersion);
+            $library->setVerified(True);
+            $library->setActive(True);
+            $library->setIsBuiltIn(True);
+
+            $version = new Version();
+            $version->setLibrary($library);
+            $version->setVersion($builtInVersion);
+            $version->setFolderName($builtInVersion);
+            $version->addArchitecture($avrArchitecture);
+
+            /* @var ApiHandler $handler */
+            $handler = $this->container->get('codebender_library.apiHandler');
+            $examples = $handler->fetchLibraryExamples(new Finder(), $builtInLibrary->getPathname());
+            foreach ($examples as $example) {
+                $libraryExample = new LibraryExample();
+                $libraryExample->setVersion($version);
+                $libraryExample->setName(pathinfo($example['filename'])['filename']);
+                $libraryExample->setPath($example['filename']);
+                $libraryExample->setBoards(null);
+
+                $entityManager->persist($libraryExample);
+            }
+
+            $library->addVersion($version);
+            $library->setLatestVersion($version);
+
+            /*
+             * Persist and move library files
+             */
+            $entityManager->persist($library);
+            $entityManager->persist($version);
+            $this->moveBuiltInLibraryFiles($builtInLibrary, $builtInVersion);
+        }
+        $entityManager->flush();
+
+        /*
+         * 4. Migrate existing authorization key
+         */
+        $authorizationKey = $this->container->getParameter('authorizationKey');
+        $codebender = new Partner();
+        $codebender->setName('Codebender');
+        $codebender->setAuthKey($authorizationKey);
+        $entityManager->persist($codebender);
+        $entityManager->flush();
+
+        /*
+         * 5. Set all existing versions as the preferred version for Codebender
+         */
+        $libraries = $entityManager->getRepository('CodebenderLibraryBundle:Library')->findAll();
+        /* @var Library $library */
+        foreach ($libraries as $library) {
+            $preference = new Preference();
+            $preference->setLibrary($library);
+            $preference->setVersion($library->getLatestVersion());
+            $codebender->addPreference($preference);
+
+            $entityManager->persist($preference);
+            $entityManager->persist($codebender);
+        }
+        $entityManager->flush();
+    }
+
+    /**
+     * This method moves an existing built-in library folder from the given sourceFolder to its
+     * new location. The old directory is removed after this operation.
+     *
+     * @param SplFileInfo $sourceFolder
+     * @param $version
+     */
+    private function moveBuiltInLibraryFiles(SplFileInfo $sourceFolder, $version)
+    {
+        $defaultHeader = $sourceFolder->getFilename();
+
+        /* @var Filesystem $filesystem */
+        $filesystem = new Filesystem();
+        $sourcePath = $sourceFolder->getPathname();
+        $destinationRootDirectory = $this->container->getParameter('external_libraries_v2');
+        $destinationPath = $destinationRootDirectory . '/' . $defaultHeader . '/' . $version;
+        $filesystem->mirror($sourcePath, $destinationPath);
+    }
+
+    /**
+     * This method moves an existing external library folder from the existing location to its
+     * new location. The old directory is removed after this operation.
+     *
+     * @param $defaultHeader
+     * @param $version
+     */
+    private function moveExternalLibraryFiles($defaultHeader, $version)
+    {
+        /* @var Filesystem $filesystem */
+        $filesystem = new Filesystem();
+        $sourceRootDirectory = $this->container->getParameter('external_libraries');
+        $destinationRootDirectory = $this->container->getParameter('external_libraries_v2');
+        $sourcePath = $sourceRootDirectory . '/' . $defaultHeader;
+        $destinationPath = $destinationRootDirectory . '/' . $defaultHeader . '/' . $version;
+        $filesystem->mirror($sourcePath, $destinationPath);
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema)
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE Library DROP is_built_in');
+    }
+}