Merge pull request #5 from continuousphp/state-param

Added state param to get packages of one or more specific states only

Author: ppaulis

README.md

@@ -42,13 +42,14 @@ The goal of this task is to setup your credential in order to start consuming
 This task helps you to get a package url for a repository.
 
 #### 2.1. Attributes
-| Name        | Type   | Description                                                         | Default | Required |
-| ----------- | ------ | ------------------------------------------------------------------- | ------- | -------- |
-| provider    | String | the repository provider platform (git-hub, bitbucket...)            | n/a     | Yes      |
-| repository  | String | the repository name                                                 | n/a     | Yes      |
-| reference   | String | the GIT reference of the package                                    | n/a     | No       |
-| destination | String | the GIT reference of the package                                    | n/a     | No       |
-| property    | String | the property in which the download URL or file path will be defined | n/a     | No       |
+| Name        | Type   | Description                                                         | Default  | Required |
+| ----------- | ------ | ------------------------------------------------------------------- | -------- | -------- |
+| provider    | String | the repository provider platform (git-hub, bitbucket...)            | n/a      | Yes      |
+| repository  | String | the repository name                                                 | n/a      | Yes      |
+| reference   | String | the GIT reference of the package                                    | n/a      | No       |
+| state       | String | the allowed build states, can be "complete", "in-progress", or both | complete | No       |
+| destination | String | the Download destination for the package                            | n/a      | No       |
+| property    | String | the property in which the download URL or file path will be defined | n/a      | No       |
 
 #### 2.2 Example
 ```xml
@@ -65,6 +66,7 @@ Download the package by adding the destination
             provider="git-hub"
             repository="continuousphp/phing-tasks"
             reference="refs/heads/master"
+            state="in-progress,complete"
             destination="/tmp"
             property="package.path" />
 ```

build.xml

@@ -24,4 +24,14 @@
         <echo message="---PACKAGE_URL:${package.url}---" />
     </target>
 
+    <target name="package-with-state" description="Ouput the package url">
+        <continuousphp-package
+                provider="${provider}"
+                repository="${repository}"
+                reference="${reference}"
+                state="${state}"
+                property="package.url" />
+        <echo message="---PACKAGE_URL:${package.url}---" />
+    </target>
+
 </project>

features/bootstrap/TaskContext.php

@@ -35,6 +35,11 @@ class TaskContext implements Context, SnippetAcceptingContext
      */
     protected $reference;
 
+    /**
+     * @var string
+     */
+    protected $state;
+
     /**
      * @var string
      */
@@ -83,6 +88,14 @@ public function setReference($reference)
         $this->reference = $reference;
     }
 
+    /**
+     * @Given the state :state
+     */
+    public function setState($state)
+    {
+        $this->state = $state;
+    }
+
     /**
      * @When I use the continuousphp package task
      */
@@ -93,7 +106,28 @@ public function runPackageTask()
                  . " -Dprovider=" . $this->provider
                  . " -Drepository=" . $this->repository
                  . " -Dreference=" . $this->reference;
+
+        exec($command, $output, $return);
+
+        if ($return) {
+            throw new \RuntimeException(implode(PHP_EOL, $output), $return);
+        }
 
+        $this->lastOutput = implode(PHP_EOL, $output);
+    }
+
+    /**
+     * @When I use the continuousphp package-with-state task
+     */
+    public function runPackageWithStateTask()
+    {
+        $command = self::PHING_BIN_PATH . ' config package-with-state'
+            . " -Dtoken=" . $this->token
+            . " -Dprovider=" . $this->provider
+            . " -Drepository=" . $this->repository
+            . " -Dreference=" . $this->reference
+            . " -Dstate=" . $this->state;
+
         exec($command, $output, $return);
 
         if ($return) {

features/package.feature

@@ -9,4 +9,13 @@ Feature: continuousphp package
     And the repository "continuousphp/phing-tasks"
     And the reference "refs/heads/master"
     When I use the continuousphp package task
+    Then I should retrieve a valid download url
+
+  Scenario: Get the last build of master branch, specifying the state manually
+    Given I've the token "e391f57ddd27bb37097a5c46a47776289cf1eff7"
+    And the provider "git-hub"
+    And the repository "continuousphp/phing-tasks"
+    And the reference "refs/heads/master"
+    And the state "complete,in-progress"
+    When I use the continuousphp package-with-state task
     Then I should retrieve a valid download url

src/PackageTask.php

@@ -26,6 +26,11 @@ class PackageTask extends AbstractTask
      */
     protected $reference;
 
+    /**
+     * @var string
+     */
+    protected $state;
+
     /**
      * @var string
      */
@@ -57,6 +62,25 @@ public function setReference($reference)
         return $this;
     }
 
+    /**
+     * @param string $stateList
+     * @return $this
+     */
+    public function setState($stateList)
+    {
+        $this->state = [];
+        
+        foreach(explode(',', $stateList) as $state) {
+            $state = trim($state);
+
+            if ($state) {
+                $this->state[] = $state;
+            }
+        }
+        
+        return $this;
+    }
+
     /**
      * @param string $provider
      * @return $this
@@ -108,19 +132,19 @@ public function setDestination($destination)
     public function main()
     {
         $projectFilter = [
-            'provider' => $this->provider,
+            'provider'   => $this->provider,
             'repository' => $this->repository,
-            'state' => ['complete'],
-            'result' => ['success', 'warning']
+            'result'     => ['success', 'warning']
         ];
 
+        $projectFilter['state'] = $this->state ? : ['complete'];
+
         if ($this->reference) {
             $projectFilter['ref'] = $this->reference;
         }
 
         // Get the build list
-        $builds = $this->getClient()
-            ->getBuilds($projectFilter);
+        $builds = $this->getClient()->getBuilds($projectFilter);
 
         if (empty($builds['_embedded']['builds'])) {
             $message = 'No build found for the project "' . $this->provider . '/' . $this->repository . '"';

tests/PackageTaskTest.php

@@ -58,4 +58,31 @@ public function testPropertySetter()
         $this->assertSame($task, $task->setProperty($property));
         $this->assertAttributeSame($property, 'property', $task);
     }
+
+    public function testStateSetter()
+    {
+        $stateList = 'in-progress,complete';
+
+        $task = new PackageTask();
+        $this->assertSame($task, $task->setState($stateList));
+        $this->assertAttributeSame(['in-progress', 'complete'], 'state', $task);
+    }
+
+    public function testStateSetter_WithWhiteSpaces()
+    {
+        $stateList = 'in-progress , complete';
+
+        $task = new PackageTask();
+        $this->assertSame($task, $task->setState($stateList));
+        $this->assertAttributeSame(['in-progress', 'complete'], 'state', $task);
+    }
+
+    public function testStateSetter_WithEmptyValue()
+    {
+        $stateList = 'in-progress , ';
+
+        $task = new PackageTask();
+        $this->assertSame($task, $task->setState($stateList));
+        $this->assertAttributeSame(['in-progress'], 'state', $task);
+    }
 }