Migrate from Travis to GitHub Actions (#24)

Author: jkribeiro

.travis/test-script.sh renamed to .github/workflows/test-script.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+SITE_ROOT="/tmp/site/mysite"
 SITE_WEB="$SITE_ROOT/web"
 SITE_APP="$SITE_ROOT/app"
 
@@ -34,6 +34,8 @@ else
   echo "${MSG_OK} 'web' folder exists"
 fi
 
+cd "$SITE_ROOT"
+
 ##
 # Check if the stub files exist.
 # See \DrupalComposer\DrupalParanoia $frontControllers
@@ -123,12 +125,12 @@ fi
 ##
 # Create a theme image, run the command 'composer drupal:paranoia' and check if the image has been symlinked.
 #
-touch "$SITE_APP/themes/travis-test-image.jpg"
+touch "$SITE_APP/themes/test-image.jpg"
 
 # Rebuild web directory.
 composer drupal:paranoia || exit 1
 
-if [ ! -L "$SITE_WEB/themes/travis-test-image.jpg" ]; then
+if [ ! -L "$SITE_WEB/themes/test-image.jpg" ]; then
   echo "${MSG_ERROR} 'composer drupal:paranoia' command did not re-create the web directory with new symlinks"
   exit 1
 else

.github/workflows/testing.yml

@@ -0,0 +1,49 @@
+name: "Testing"
+on: push
+env:
+  SITE_NAME: "mysite"
+  SITE_ROOT: "/tmp/site/mysite"
+jobs:
+  testing:
+    name: "Automated tests"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      -
+        name: "Install Composer"
+        run: |
+          php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+          php -r "if (hash_file('sha384', 'composer-setup.php') === '906a84df04cea2aa72f40b5f787e49f22d4c2f19492ac310e8cba5b96ac8b64115ac402c8cd292b8a03482574915d1a8') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
+          php composer-setup.php
+          php -r "unlink('composer-setup.php');"
+          mv composer.phar /usr/local/bin/composer
+      -
+        name: "Install a site"
+        run: |
+          # Create Drupal project.
+          composer create-project drupal-composer/drupal-project:9.x-dev --stability dev --no-interaction --no-dev --prefer-dist "$SITE_ROOT" || exit 1
+
+          # https://github.com/drupal-composer/drupal-paranoia#configuration
+          cd "$SITE_ROOT"
+          mv "$SITE_ROOT/web" "$SITE_ROOT/app"
+          sed -e "s?web/?app/?g" --in-place "$SITE_ROOT/composer.json"
+          composer config extra.drupal-paranoia.app-dir app
+          composer config extra.drupal-paranoia.web-dir web
+
+          # Require local drupal-paranoia project.
+          composer config repositories.local_drupal_paranoia path "$GITHUB_WORKSPACE"
+          composer require --update-no-dev drupal-composer/drupal-paranoia:"*" || exit 1
+      -
+        name: "Sniff code standards"
+        run: |
+          COMPOSER_GLOBAL_HOME=$( composer -n config --global home )
+          PATH="$PATH:$COMPOSER_GLOBAL_HOME/vendor/bin"
+          composer global require drupal/coder --prefer-dist || exit 1
+          phpcs --config-set installed_paths "$COMPOSER_GLOBAL_HOME/vendor/drupal/coder/coder_sniffer"
+          phpcs --config-set ignore_warnings_on_exit 1
+          phpcs --standard=Drupal --ignore=*.md,*.txt,.github/* --warning-severity=0 -d date.timezone=UTC .
+      -
+        name: "Run Test"
+        run: |
+          # Run test script.
+          $GITHUB_WORKSPACE/.github/workflows/test-script.sh

.travis.yml

@@ -1,5 +1,5 @@
 [![Packagist Downloads](https://img.shields.io/packagist/dt/drupal-composer/drupal-paranoia.svg)](https://packagist.org/packages/drupal-composer/drupal-paranoia)
-[![Build Status](https://travis-ci.org/drupal-composer/drupal-paranoia.svg?branch=1.x)](https://travis-ci.org/drupal-composer/drupal-paranoia)
+[![Testing](https://github.com/drupal-composer/drupal-paranoia/actions/workflows/testing.yml/badge.svg)](https://github.com/drupal-composer/drupal-paranoia/actions/workflows/testing.yml)
 
 # Drupal Paranoia
 Composer plugin for improving the website security for composer-based Drupal websites by moving all __PHP files out of docroot__.

README.md

@@ -55,7 +55,7 @@ class AssetFileTypesEvent extends Event {
    * @param array $flags
    *   Optional flags to pass data not as argument.
    */
-  public function __construct(array $assetFileTypes, Composer $composer, IOInterface $io, array $args = array(), array $flags = array()) {
+  public function __construct(array $assetFileTypes, Composer $composer, IOInterface $io, array $args = [], array $flags = []) {
     parent::__construct(self::POST_DRUPAL_SET_ASSET_FILE_TYPES, $args, $flags);
 
     $this->composer = $composer;

src/AssetFileTypesEvent.php

@@ -15,9 +15,9 @@ class CommandProvider implements CommandProviderCapability {
    * {@inheritdoc}
    */
   public function getCommands() {
-    return array(
+    return [
       new DrupalParanoiaCommand(),
-    );
+    ];
   }
 
 }

src/CommandProvider.php

@@ -21,7 +21,7 @@ protected function configure() {
     parent::configure();
     $this
       ->setName('drupal:paranoia')
-      ->setAliases(array('drupal-paranoia'))
+      ->setAliases(['drupal-paranoia'])
       ->setDescription('Execute the installation of the paranoia mode.');
   }
 

src/DrupalParanoiaCommand.php

@@ -46,12 +46,12 @@ class Installer {
    *
    * @var array
    */
-  public $frontControllers = array(
+  public $frontControllers = [
     'index.php',
     'core/install.php',
     'core/rebuild.php',
     'core/modules/statistics/statistics.php',
-  );
+  ];
 
   /**
    * Flag indicating whether is to run the paranoia installation or not.
@@ -108,7 +108,7 @@ public function __construct(Composer $composer, IOInterface $io) {
 
     $this->setAssetFileTypes();
 
-    $this->excludes = $this->getConfig('excludes', array());
+    $this->excludes = $this->getConfig('excludes', []);
   }
 
   /**
@@ -126,11 +126,11 @@ public function getConfig($name, $default = NULL) {
     $extra = $this->composer->getPackage()->getExtra();
 
     // TODO: Backward compatibility for old configs. Remove on stable version.
-    $legacyConfigs = array(
+    $legacyConfigs = [
       'drupal-app-dir',
       'drupal-web-dir',
       'drupal-asset-files',
-    );
+    ];
     if (in_array("drupal-$name", $legacyConfigs) && isset($extra["drupal-$name"])) {
       return $extra["drupal-$name"];
     }
@@ -264,7 +264,7 @@ public function install() {
     }
 
     // Ensure that the app and web directories exist.
-    $fs->mkdir(array($this->appDir, $this->webDir));
+    $fs->mkdir([$this->appDir, $this->webDir]);
 
     // Create the stub files.
     foreach ($this->frontControllers as $fileName) {
@@ -291,7 +291,7 @@ public function getSitesPublicFilesPath() {
     $finder->in($this->appDir . '/sites')
       ->depth(0);
 
-    $directories = array();
+    $directories = [];
 
     /** @var \Symfony\Component\Finder\SplFileInfo $directory */
     foreach ($finder->directories() as $directory) {
@@ -403,7 +403,7 @@ public function createStubPhpFile($path) {
    * Set the asset file types.
    */
   public function setAssetFileTypes() {
-    $this->assetFileTypes = array(
+    $this->assetFileTypes = [
       'robots.txt',
       '.htaccess',
       '*.css',
@@ -420,7 +420,7 @@ public function setAssetFileTypes() {
       '*.ttf',
       '*.woff',
       '*.woff2',
-    );
+    ];
 
     // Allow people to extend the list from a composer extra key.
     $extraAssetFiles = $this->getConfig('asset-files');

src/Installer.php

@@ -45,22 +45,22 @@ public function uninstall(Composer $composer, IOInterface $io) {}
    * {@inheritdoc}
    */
   public function getCapabilities() {
-    return array(
+    return [
       'Composer\Plugin\Capability\CommandProvider' => 'DrupalComposer\DrupalParanoia\CommandProvider',
-    );
+    ];
   }
 
   /**
    * {@inheritdoc}
    */
   public static function getSubscribedEvents() {
-    return array(
-      PackageEvents::POST_PACKAGE_INSTALL => array('postPackage'),
-      PackageEvents::POST_PACKAGE_UPDATE => array('postPackage'),
-      PackageEvents::POST_PACKAGE_UNINSTALL => array('postPackage'),
-      ScriptEvents::POST_INSTALL_CMD => array('postCmd', -1),
-      ScriptEvents::POST_UPDATE_CMD => array('postCmd', -1),
-    );
+    return [
+      PackageEvents::POST_PACKAGE_INSTALL => ['postPackage'],
+      PackageEvents::POST_PACKAGE_UPDATE => ['postPackage'],
+      PackageEvents::POST_PACKAGE_UNINSTALL => ['postPackage'],
+      ScriptEvents::POST_INSTALL_CMD => ['postCmd', -1],
+      ScriptEvents::POST_UPDATE_CMD => ['postCmd', -1],
+    ];
   }
 
   /**