Add specs. Plus, minor fixes.

app/finders/pipelines_finder.rb

@@ -88,8 +88,12 @@ class PipelinesFinder
   end
 
   def by_yaml_errors(items)
-    if params[:yaml_errors].present? && params[:yaml_errors]
-      items.where("yaml_errors IS NOT NULL")
+    if params[:yaml_errors].present? 
+      if params[:yaml_errors]
+        items.where("yaml_errors IS NOT NULL")
+      else
+        items.where("yaml_errors IS NULL")
+      end
     else
       items
     end

doc/api/pipelines.md

@@ -16,7 +16,7 @@ GET /projects/:id/pipelines
 | `ref`     | string  | no       | The ref of pipelines |
 | `yaml_errors`| string  | no       | If true, Returns only yaml error pipelines |
 | `username`| string  | no       | The name of user who triggered pipelines |
-| `order_by`| string  | no       | The order_by which is combined with a `sort`, one of: `id`, `status`, `ref`, `user_id`, `started_at`, `finished_at`, `created_at`, `updated_at`; |
+| `order_by`| string  | no       | The order_by which is combined with a `sort`, one of: `id`, `status`, `ref`, `username`, `started_at`, `finished_at`, `created_at`, `updated_at`; |
 | `sort`    | string  | no       | The sort method which is combined with an `order_by`, one of: `asc`, `desc`; |
 
 ```

lib/api/pipelines.rb

@@ -21,7 +21,7 @@ module API
         optional :ref,      type: String, desc: 'The ref of pipelines'
         optional :yaml_errors, type: Boolean, desc: 'If true, Returns only yaml error pipelines'
         optional :username, type: String, desc: 'The name of user who triggered pipelines'
-        optional :order_by, type: String, values: ['id', 'status', 'ref', 'user_id', 'started_at', 'finished_at', 'created_at', 'updated_at'], default: 'id',
+        optional :order_by, type: String, values: ['id', 'status', 'ref', 'username', 'started_at', 'finished_at', 'created_at', 'updated_at'], default: 'id',
                             desc: 'The order_by which is combined with a sort'
         optional :sort,     type: String, values: ['asc', 'desc'], default: 'desc',
                             desc: 'The sort method which is combined with an order_by'

spec/finders/pipelines_finder_spec.rb

@@ -1,22 +1,75 @@
 require 'spec_helper'
 
 describe PipelinesFinder do
+  let(:user) { create(:user) }
   let(:project) { create(:project, :repository) }
 
-  let!(:tag_pipeline)    { create(:ci_pipeline, project: project, ref: 'v1.0.0') }
-  let!(:branch_pipeline) { create(:ci_pipeline, project: project) }
+  let!(:tag_pipeline)         { create(:ci_pipeline, project: project, user: user, ref: 'v1.0.0') }
+  let!(:created_pipeline)     { create(:ci_pipeline, project: project, user: user, status: 'created') }
+  let!(:pending_pipeline)     { create(:ci_pipeline, project: project, user: user, status: 'pending') }
+  let!(:running_pipeline)     { create(:ci_pipeline, project: project, user: user, status: 'running') }
+  let!(:success_pipeline)     { create(:ci_pipeline, project: project, user: user, status: 'success') }
+  let!(:failed_pipeline)      { create(:ci_pipeline, project: project, user: user, status: 'failed') }
+  let!(:canceled_pipeline)    { create(:ci_pipeline, project: project, user: user, status: 'canceled') }
+  let!(:skipped_pipeline)     { create(:ci_pipeline, project: project, user: user, status: 'skipped') }
+  let!(:yaml_errors_pipeline) { create(:ci_pipeline, project: project, user: user, yaml_errors: 'Syntax error') }
 
-  subject { described_class.new(project).execute(params) }
+  subject { described_class.new(project, params).execute }
 
   describe "#execute" do
-    context 'when a scope is passed' do
-      context 'when scope is nil' do
-        let(:params) { { scope: nil } }
+    context 'when nothing is passed' do
+      let(:params) { {} }
 
-        it 'selects all pipelines' do
-          expect(subject.count).to be 2
-          expect(subject).to include tag_pipeline
-          expect(subject).to include branch_pipeline
+      it 'selects all pipelines' do
+        expect(subject.count).to be 9
+        expect(subject).to include tag_pipeline
+        expect(subject).to include created_pipeline
+        expect(subject).to include pending_pipeline
+        expect(subject).to include running_pipeline
+        expect(subject).to include success_pipeline
+        expect(subject).to include failed_pipeline
+        expect(subject).to include canceled_pipeline
+        expect(subject).to include skipped_pipeline
+        expect(subject).to include yaml_errors_pipeline
+      end
+
+      it 'orders in descending order on ID' do
+        expected_ids = [
+          tag_pipeline.id, 
+          created_pipeline.id, 
+          pending_pipeline.id,
+          running_pipeline.id,
+          success_pipeline.id,
+          failed_pipeline.id,
+          canceled_pipeline.id,
+          skipped_pipeline.id,
+          yaml_errors_pipeline.id].sort.reverse
+        expect(subject.map(&:id)).to eq expected_ids
+      end
+    end
+
+    context 'when a scope is passed' do
+      context 'when selecting running' do
+        let(:params) { { scope: 'running' } }
+
+        it 'has only running status' do
+          expect(subject.map(&:status)).to include('running')
+        end
+      end
+
+      context 'when selecting pending' do
+        let(:params) { { scope: 'pending' } }
+
+        it 'has only pending status' do
+          expect(subject.map(&:status)).to include('pending')
+        end
+      end
+
+      context 'when selecting finished' do
+        let(:params) { { scope: 'finished' } }
+
+        it 'has only finished status' do
+          expect(subject.map(&:status)).to match_array %w(success canceled failed)
         end
       end
 
@@ -24,8 +77,9 @@ describe PipelinesFinder do
         let(:params) { { scope: 'branches' } }
 
         it 'excludes tags' do
+          expect(subject.count).to be 1
           expect(subject).not_to include tag_pipeline
-          expect(subject).to     include branch_pipeline
+          expect(subject.map(&:ref)).to include('master')
         end
       end
 
@@ -33,20 +87,150 @@ describe PipelinesFinder do
         let(:params) { { scope: 'tags' } }
 
         it 'excludes branches' do
+          expect(subject.count).to be 1
           expect(subject).to     include tag_pipeline
-          expect(subject).not_to include branch_pipeline
+          expect(subject.map(&:ref)).not_to include('master')
         end
       end
     end
 
-    # Scoping to pending will speed up the test as it doesn't hit the FS
-    let(:params) { { scope: 'pending' } }
+    context 'when a status is passed' do
+      context 'when selecting running' do
+        let(:params) { { scope: 'running' } }
 
-    it 'orders in descending order on ID' do
-      feature_pipeline = create(:ci_pipeline, project: project, ref: 'feature')
+        it 'has only running status' do
+          expect(subject.map(&:status)).to include('running')
+        end
+      end
 
-      expected_ids = [feature_pipeline.id, branch_pipeline.id, tag_pipeline.id].sort.reverse
-      expect(subject.map(&:id)).to eq expected_ids
+      context 'when selecting pending' do
+        let(:params) { { scope: 'pending' } }
+
+        it 'has only pending status' do
+          expect(subject.map(&:status)).to include('pending')
+        end
+      end
+
+      context 'when selecting success' do
+        let(:params) { { scope: 'success' } }
+
+        it 'has only success status' do
+          expect(subject.map(&:status)).to include('success')
+        end
+      end
+
+      context 'when selecting failed' do
+        let(:params) { { scope: 'failed' } }
+
+        it 'has only failed status' do
+          expect(subject.map(&:status)).to include('failed')
+        end
+      end
+
+      context 'when selecting canceled' do
+        let(:params) { { scope: 'canceled' } }
+
+        it 'has only canceled status' do
+          expect(subject.map(&:status)).to include('canceled')
+        end
+      end
+
+      context 'when selecting skipped' do
+        let(:params) { { scope: 'skipped' } }
+
+        it 'has only skipped status' do
+          expect(subject.map(&:status)).to include('skipped')
+        end
+      end
+    end 
+    
+    context 'when a ref is passed' do
+      context 'when a ref exists' do
+        let(:params) { { ref: 'master' } }
+
+        it 'selects all pipelines which belong to the ref' do
+          expect(subject.count).to be 8
+          expect(subject).to include created_pipeline
+          expect(subject).to include pending_pipeline
+          expect(subject).to include running_pipeline
+          expect(subject).to include success_pipeline
+          expect(subject).to include failed_pipeline
+          expect(subject).to include canceled_pipeline
+          expect(subject).to include skipped_pipeline
+          expect(subject).to include yaml_errors_pipeline
+        end
+      end
+
+      context 'when a ref does not exist' do
+        let(:params) { { ref: 'unique-ref' } }
+
+        it 'selects nothing' do
+          expect(subject).to be_empty
+        end
+      end
+    end  
+
+    context 'when a username is passed' do
+      context 'when a username exists' do
+        let(:params) { { username: user.name } }
+
+        it 'selects all pipelines which belong to the username' do
+          expect(subject).to include success_pipeline
+          expect(subject).to include failed_pipeline
+        end
+      end
+
+      context 'when a username does not exist' do
+        let(:params) { { username: 'unique-username' } }
+
+        it 'selects nothing' do
+          expect(subject).to be_empty
+        end
+      end
+    end  
+
+    context 'when a yaml_errors is passed' do
+      context 'when yaml_errors is true' do
+        let(:params) { { yaml_errors: true } }
+
+        it 'selects only pipelines has yaml_errors' do
+          expect(subject).to include yaml_errors_pipeline
+        end
+      end
+
+      context 'when yaml_errors is false' do
+        let(:params) { { yaml_errors: false } }
+
+        it 'selects only pipelines does not have yaml_errors' do
+          expect(subject).to include created_pipeline
+          expect(subject).to include pending_pipeline
+          expect(subject).to include running_pipeline
+          expect(subject).to include success_pipeline
+          expect(subject).to include failed_pipeline
+          expect(subject).to include canceled_pipeline
+          expect(subject).to include skipped_pipeline
+        end
+      end
+    end
+
+    context 'when a order_by and sort are passed' do
+      context 'when order by started_at asc' do
+        let(:params) { { order_by: 'created_at', sort: 'asc' } }
+
+        it 'sorts by started_at asc' do
+          expected_created_at = [
+            tag_pipeline.created_at, 
+            created_pipeline.created_at, 
+            pending_pipeline.created_at,
+            running_pipeline.created_at,
+            success_pipeline.created_at,
+            failed_pipeline.created_at,
+            canceled_pipeline.created_at,
+            skipped_pipeline.created_at,
+            yaml_errors_pipeline.created_at].sort
+          expect(subject.map(&:created_at)).to eq expected_created_at
+        end
+      end
     end
   end
 end