Merge branch '51794-add-ordering-to-runner-jobs-api' into 'master'

Adding order by to list runner jobs api.

Closes #51794

See merge request gitlab-org/gitlab-ce!29629

2 files changed, 66 insertions, 0 deletions

diff --git a/spec/finders/runner_jobs_finder_spec.rb b/spec/finders/runner_jobs_finder_spec.rb
index 97304170c4e..01f45a37ba8 100644
--- a/spec/finders/runner_jobs_finder_spec.rb
+++ b/spec/finders/runner_jobs_finder_spec.rb
@@ -35,5 +35,27 @@ describe RunnerJobsFinder do
         end
       end
     end
+
+    context 'when order_by and sort are specified' do
+      context 'when order_by id and sort is asc' do
+        let(:params) { { order_by: 'id', sort: 'asc' } }
+        let!(:jobs) { create_list(:ci_build, 2, runner: runner, project: project, user: create(:user)) }
+
+        it 'sorts as id: :asc' do
+          is_expected.to eq(jobs.sort_by(&:id))
+        end
+      end
+    end
+
+    context 'when order_by is specified and sort is not specified' do
+      context 'when order_by id and sort is not specified' do
+        let(:params) { { order_by: 'id' } }
+        let!(:jobs) { create_list(:ci_build, 2, runner: runner, project: project, user: create(:user)) }
+
+        it 'sorts as id: :desc' do
+          is_expected.to eq(jobs.sort_by(&:id).reverse)
+        end
+      end
+    end
   end
 end
diff --git a/spec/requests/api/runners_spec.rb b/spec/requests/api/runners_spec.rb
index 5548e3fd01a..f5ce3a3570e 100644
--- a/spec/requests/api/runners_spec.rb
+++ b/spec/requests/api/runners_spec.rb
@@ -584,6 +584,34 @@ describe API::Runners do
           end
         end
 
+        context 'when valid order_by is provided' do
+          context 'when sort order is not specified' do
+            it 'return jobs in descending order' do
+              get api("/runners/#{project_runner.id}/jobs?order_by=id", admin)
+
+              expect(response).to have_gitlab_http_status(200)
+              expect(response).to include_pagination_headers
+
+              expect(json_response).to be_an(Array)
+              expect(json_response.length).to eq(2)
+              expect(json_response.first).to include('id' => job_5.id)
+            end
+          end
+
+          context 'when sort order is specified as asc' do
+            it 'return jobs sorted in ascending order' do
+              get api("/runners/#{project_runner.id}/jobs?order_by=id&sort=asc", admin)
+
+              expect(response).to have_gitlab_http_status(200)
+              expect(response).to include_pagination_headers
+
+              expect(json_response).to be_an(Array)
+              expect(json_response.length).to eq(2)
+              expect(json_response.first).to include('id' => job_4.id)
+            end
+          end
+        end
+
         context 'when invalid status is provided' do
           it 'return 400' do
             get api("/runners/#{project_runner.id}/jobs?status=non-existing", admin)
@@ -591,6 +619,22 @@ describe API::Runners do
             expect(response).to have_gitlab_http_status(400)
           end
         end
+
+        context 'when invalid order_by is provided' do
+          it 'return 400' do
+            get api("/runners/#{project_runner.id}/jobs?order_by=non-existing", admin)
+
+            expect(response).to have_gitlab_http_status(400)
+          end
+        end
+
+        context 'when invalid sort is provided' do
+          it 'return 400' do
+            get api("/runners/#{project_runner.id}/jobs?sort=non-existing", admin)
+
+            expect(response).to have_gitlab_http_status(400)
+          end
+        end
       end
 
       context "when runner doesn't exist" do