added download retries + support for multiple version queries to support sources where that is a thing (like chromedriver repository)

Author: Allan Paiste

LICENSE_VAIMO.txt

@@ -1,4 +1,4 @@
-Copyright © 2009-2018 Vaimo Group.
+Copyright © 2009-2019 Vaimo Group.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of 
 this software and associated documentation files (the "Software"), to deal in 

bin/analyse

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+: <<'COPYRIGHT'
+ Copyright (c) Vaimo Group. All rights reserved.
+ See LICENSE_VAIMO.txt for license details.
+COPYRIGHT
+
+type=${1}
+
+if [ "${type}" == "" ] || [ "${type}" == "phpcs" ] ; then
+    vendor/bin/phpcs -p src
+    
+    result=${?}
+
+    if [ ${result} -gt 0 ] ; then
+        exit 1
+    fi
+fi
+
+if [ "${type}" == "" ] || [ "${type}" == "phpcpd" ] ; then
+    vendor/bin/phpcpd src
+    
+    result=${?}
+
+    if [ ${result} -gt 0 ] ; then
+        exit 1
+    fi
+fi
+
+if [ "${type}" == "" ] || [ "${type}" == "phpmd" ] ; then
+    vendor/bin/phpmd src text phpmd.xml --suffixes php
+
+    result=${?}
+
+    if [ ${result} -gt 0 ] ; then
+        exit 1
+    fi
+fi

bin/bootstrap

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+: <<'COPYRIGHT'
+ Copyright (c) Vaimo Group. All rights reserved.
+ See LICENSE_VAIMO.txt for license details.
+COPYRIGHT
+
+vendor/bin/phpcs --config-set installed_paths 'vendor/phpcompatibility/php-compatibility'
+vendor/bin/phpcs --config-set error_severity 1
+vendor/bin/phpcs --config-set default_standard 'LOCAL'

bin/normalise

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+: <<'COPYRIGHT'
+ Copyright (c) Vaimo Group. All rights reserved.
+ See LICENSE_VAIMO.txt for license details.
+COPYRIGHT
+
+vendor/bin/phpcbf -p src
+
+exit 0

changelog.json

@@ -1,7 +1,23 @@
 {
+    "_readme": [
+        "The contents of this file are used to generate CHANGELOG.md; It's kept in JSON/parsable format to make it",
+        "possible to generate change-logs in other formats as well (when needed) and to do automatic releases based on",
+        "added change-log records. More on how to use it: https://github.com/vaimo/composer-changelogs"
+    ],
+    "2.1.0": {
+        "feature": [
+            "allow multiple version checking url's to cater for download sources that might have different mechanisms for fetching information about latest driver versions",
+            "new path variables for having partial version in file names: major (X), major-minor (X.Y)",
+            "retry driver download when download failed for some reason (2 retries)"
+        ],
+        "maintenance": [
+            "introduced the use of Static Code Analysis tools",
+            "code downgraded so to make the package installable on relatively old php versions"
+        ]
+    },
     "2.0.0": {
         "breaking": [
-            "(config) version polling output parser switched to use refex pattern matching instead of relying on sscanf"
+            "(config) version polling output parser switched to use RegEx pattern matching instead of relying on sscanf"
         ],
         "feature": [
             "allow driver version polling to use version aliases (required for some drivers that use multiple versioning schemes (like EdgeDriver))",

composer.json

@@ -4,9 +4,36 @@
     "license": "MIT",
     "description": "General-issue library that enables building any kind of WebDriver binary downloader",
     "require": {
+        "php": ">=5.3.0",
         "composer/composer": "^1.0",
         "composer-plugin-api": "^1.0"
     },
+    "require-dev": {
+        "composer/composer": "^1.0.0",
+        "vaimo/composer-changelogs": "^0.15.4",
+        "squizlabs/php_codesniffer": "^2.9.2",
+        "phpcompatibility/php-compatibility": "^9.1.1",
+        "phpmd/phpmd": "^2.6.0",
+        "phpunit/phpunit": "^4.8.36",
+        "sebastian/phpcpd": "^1.4.3"
+    },
+    "config": {
+        "platform": {
+            "php": "5.3.9"
+        }
+    },
+    "scripts-descriptions": {
+        "test": "Run tests",
+        "code:analyse": "Run static code analysis for the source code",
+        "code:normalise": "Apply automatic fixes to the code based on the static code analysis (where applicable)"
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "code:analyse": "bin/analyse",
+        "code:normalise": "bin/normalise",
+        "post-install-cmd": "bin/bootstrap",
+        "post-update-cmd" : "bin/bootstrap"
+    },
     "authors": [
         {
             "name": "Allan Paiste",
@@ -32,7 +59,10 @@
     },
     "extra": {
         "changelog": {
-            "source": "changelog.json"
+            "source": "changelog.json",
+            "output": {
+                "md": "CHANGELOG.md"
+            }
         }
     }
 }

phpcs.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<!--
+ Copyright (c) Vaimo Group. All rights reserved.
+ See LICENSE_VAIMO.txt for license details.
+-->
+<ruleset name="LOCAL">
+    <description>My rules for PHP CodeSniffer</description>
+    
+    <rule ref="PHPCompatibility" />
+
+    <config name="testVersion" value="5.3-"/>
+    
+    <rule ref="PSR1"/>
+    <rule ref="PSR2"/>
+</ruleset>

phpmd.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<!--
+ Copyright (c) Vaimo Group. All rights reserved.
+ See LICENSE_VAIMO.txt for license details.
+-->
+<ruleset name="LOCAL">
+    <rule ref="rulesets/cleancode.xml" />
+    <rule ref="rulesets/codesize.xml" />
+    <rule ref="rulesets/design.xml" />
+    <rule ref="rulesets/naming.xml" />
+    <rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/controversial.xml" />
+</ruleset>

src/Analysers/ProjectAnalyser.php

@@ -136,10 +136,20 @@ public function resolveRequiredDriverVersion()
                 $this->environmentAnalyser->resolveBrowserVersion()
             );
 
-            $versionCheckUrl = $requestConfig[ConfigInterface::REQUEST_VERSION];
+            $versionCheckUrls = $requestConfig[ConfigInterface::REQUEST_VERSION] ?? [];
+            
+            if (!is_array($versionCheckUrls)) {
+                $versionCheckUrls = [$versionCheckUrls];
+            }
+
+            foreach ($versionCheckUrls as $versionCheckUrl) {
+                if (!$version) {
+                    break;
+                }
 
-            if (!$version && $versionCheckUrl) {
-                $version = trim(@file_get_contents($versionCheckUrl));
+                $version = trim(
+                    @file_get_contents($versionCheckUrl)
+                );
             }
 
             if (!$version) {

src/Installer.php

@@ -40,7 +40,9 @@ public function __construct(
 
     public function executeWithConfig(ConfigInterface $pluginConfig)
     {
-        $binaryDir = $this->composerRuntime->getConfig()->get('bin-dir');
+        $composerConfig = $this->composerRuntime->getConfig();
+        
+        $binaryDir = $composerConfig->get('bin-dir');
 
         $projectAnalyser = new \Vaimo\WebDriverBinaryDownloader\Analysers\ProjectAnalyser($pluginConfig);
         $packageManager = new \Vaimo\WebDriverBinaryDownloader\Installer\PackageManager($pluginConfig);
@@ -91,7 +93,7 @@ public function executeWithConfig(ConfigInterface $pluginConfig)
         );
 
         try {
-            $package = $downloadManager->downloadRelease([$version]);
+            $package = $downloadManager->downloadRelease([$version], 2);
         } catch (\Exception $exception) {
             $this->io->write(
                 sprintf('<error>%s</error>', $exception->getMessage())
@@ -114,7 +116,9 @@ public function executeWithConfig(ConfigInterface $pluginConfig)
 
     private function createCacheManager($cacheName)
     {
-        $cacheDir = $this->composerRuntime->getConfig()->get('cache-dir');
+        $composerConfig = $this->composerRuntime->getConfig();
+
+        $cacheDir = $composerConfig->get('cache-dir');
 
         return new \Composer\Cache(
             $this->io,

src/Installer/DownloadManager.php

@@ -5,6 +5,7 @@
  */
 namespace Vaimo\WebDriverBinaryDownloader\Installer;
 
+use Composer\Package\PackageInterface;
 use Vaimo\WebDriverBinaryDownloader\Interfaces\ConfigInterface;
 
 class DownloadManager
@@ -67,7 +68,7 @@ public function __construct(
         $this->utils = new \Vaimo\WebDriverBinaryDownloader\Installer\Utils();
     }
 
-    public function downloadRelease(array $versions)
+    public function downloadRelease(array $versions, $retryCount = 0)
     {
         $targetDir = $this->utils->composePath(
             rtrim($this->cacheManager->getRoot(), DIRECTORY_SEPARATOR),
@@ -78,16 +79,7 @@ public function downloadRelease(array $versions)
             $package = $this->createComposerVirtualPackage($version, $targetDir);
 
             try {
-                /** @var \Composer\Downloader\DownloaderInterface $downloader */
-                $downloader = $this->downloadManager->getDownloaderForInstalledPackage($package);
-
-                /**
-                 * Some downloaders have the option to mute the output, which is why 
-                 * there the third call argument.
-                 */
-                $downloader->download($package, $targetDir, false);
-                
-                return $package;
+                return $this->downloadPackage($package, $targetDir, $retryCount);
             } catch (\Composer\Downloader\TransportException $exception) {
                 if ($exception->getStatusCode() === 404 && $versions) {
                     continue;
@@ -115,6 +107,29 @@ public function downloadRelease(array $versions)
         throw new \Exception('Failed to download requested driver');
     }
 
+    private function downloadPackage(PackageInterface $package, $targetDir, $retryCount = 0) 
+    {
+        do {
+            try {
+                /** @var \Composer\Downloader\DownloaderInterface $downloader */
+                $downloader = $this->downloadManager->getDownloaderForInstalledPackage($package);
+
+                /**
+                 * Some downloader types have the option to mute the output,
+                 * which is why there is the third call argument (not present 
+                 * in interface footprint).  
+                 */
+                $downloader->download($package, $targetDir, false);
+            } catch (\Exception $exception) {
+                if (!$retryCount) {
+                    throw $exception;
+                }
+            }
+        } while ($retryCount-- > 0);
+        
+        return $package;
+    }
+    
     private function createComposerVirtualPackage($version, $targetDir)
     {
         $remoteFile = $this->getDownloadUrl($version);
@@ -181,15 +196,31 @@ private function getDownloadUrl($version)
         $driverHashes = $this->pluginConfig->getDriverVersionHashMap();
 
         $fileHash = $driverHashes[$version] ?? '';
+
+        $variables = [
+            'version' => $version, 
+            'hash' => $fileHash, 
+            'major' => $this->extractPartialVersion($version, 1),
+            'major-minor' => $this->extractPartialVersion($version, 2)
+        ];
 
         $fileName = $this->utils->stringFromTemplate(
             $remoteFiles[$platformCode],
-            ['version' => $version, 'hash' => $fileHash]
+            $variables
         );
 
         return $this->utils->stringFromTemplate(
             $requestConfig[ConfigInterface::REQUEST_DOWNLOAD],
-            ['version' => $version, 'file' => $fileName, 'hash' => $fileHash]
+            array_replace($variables, ['file' => $fileName])
+        );
+    }
+    
+    private function extractPartialVersion($version, $segmentCount)
+    {
+        return substr(
+            $version, 
+            0, 
+            strpos($version, '.', $segmentCount) ?: strlen($version)
         );
     }
 }