Merge branch 'backport-issue_3413' into 'master'

[EE-backport] Add group boards API endpoint

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

1 files changed, 180 insertions, 0 deletions

diff --git a/spec/support/api/boards_shared_examples.rb b/spec/support/api/boards_shared_examples.rb
new file mode 100644
index 00000000000..943c1f6ffd7
--- /dev/null
+++ b/spec/support/api/boards_shared_examples.rb
@@ -0,0 +1,180 @@
+shared_examples_for 'group and project boards' do |route_definition, ee = false|
+  let(:root_url) { route_definition.gsub(":id", board_parent.id.to_s) }
+
+  before do
+    board_parent.add_reporter(user)
+    board_parent.add_guest(guest)
+  end
+
+  def expect_schema_match_for(response, schema_file, ee)
+    if ee
+      expect(response).to match_response_schema(schema_file, dir: "ee")
+    else
+      expect(response).to match_response_schema(schema_file)
+    end
+  end
+
+  describe "GET #{route_definition}" do
+    context "when unauthenticated" do
+      it "returns authentication error" do
+        get api(root_url)
+
+        expect(response).to have_gitlab_http_status(401)
+      end
+    end
+
+    context "when authenticated" do
+      it "returns the issue boards" do
+        get api(root_url, user)
+
+        expect(response).to have_gitlab_http_status(200)
+        expect(response).to include_pagination_headers
+
+        expect_schema_match_for(response, 'public_api/v4/boards', ee)
+      end
+
+      describe "GET #{route_definition}/:board_id" do
+        let(:url) { "#{root_url}/#{board.id}" }
+
+        it 'get a single board by id' do
+          get api(url, user)
+
+          expect_schema_match_for(response, 'public_api/v4/board', ee)
+        end
+      end
+    end
+  end
+
+  describe "GET #{route_definition}/:board_id/lists" do
+    let(:url) { "#{root_url}/#{board.id}/lists" }
+
+    it 'returns issue board lists' do
+      get api(url, user)
+
+      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['label']['name']).to eq(dev_label.title)
+    end
+
+    it 'returns 404 if board not found' do
+      get api("#{root_url}/22343/lists", user)
+
+      expect(response).to have_gitlab_http_status(404)
+    end
+  end
+
+  describe "GET #{route_definition}/:board_id/lists/:list_id" do
+    let(:url) { "#{root_url}/#{board.id}/lists" }
+
+    it 'returns a list' do
+      get api("#{url}/#{dev_list.id}", user)
+
+      expect(response).to have_gitlab_http_status(200)
+      expect(json_response['id']).to eq(dev_list.id)
+      expect(json_response['label']['name']).to eq(dev_label.title)
+      expect(json_response['position']).to eq(1)
+    end
+
+    it 'returns 404 if list not found' do
+      get api("#{url}/5324", user)
+
+      expect(response).to have_gitlab_http_status(404)
+    end
+  end
+
+  describe "POST #{route_definition}/lists" do
+    let(:url) { "#{root_url}/#{board.id}/lists" }
+
+    it 'creates a new issue board list for labels' do
+      post api(url, user), label_id: ux_label.id
+
+      expect(response).to have_gitlab_http_status(201)
+      expect(json_response['label']['name']).to eq(ux_label.title)
+      expect(json_response['position']).to eq(3)
+    end
+
+    it 'returns 400 when creating a new list if label_id is invalid' do
+      post api(url, user), label_id: 23423
+
+      expect(response).to have_gitlab_http_status(400)
+    end
+
+    it 'returns 403 for members with guest role' do
+      put api("#{url}/#{test_list.id}", guest), position: 1
+
+      expect(response).to have_gitlab_http_status(403)
+    end
+  end
+
+  describe "PUT #{route_definition}/:board_id/lists/:list_id to update only position" do
+    let(:url) { "#{root_url}/#{board.id}/lists" }
+
+    it "updates a list" do
+      put api("#{url}/#{test_list.id}", user),
+        position: 1
+
+      expect(response).to have_gitlab_http_status(200)
+      expect(json_response['position']).to eq(1)
+    end
+
+    it "returns 404 error if list id not found" do
+      put api("#{url}/44444", user),
+        position: 1
+
+      expect(response).to have_gitlab_http_status(404)
+    end
+
+    it "returns 403 for members with guest role" do
+      put api("#{url}/#{test_list.id}", guest),
+        position: 1
+
+      expect(response).to have_gitlab_http_status(403)
+    end
+  end
+
+  describe "DELETE #{route_definition}/lists/:list_id" do
+    let(:url) { "#{root_url}/#{board.id}/lists" }
+
+    it "rejects a non member from deleting a list" do
+      delete api("#{url}/#{dev_list.id}", non_member)
+
+      expect(response).to have_gitlab_http_status(403)
+    end
+
+    it "rejects a user with guest role from deleting a list" do
+      delete api("#{url}/#{dev_list.id}", guest)
+
+      expect(response).to have_gitlab_http_status(403)
+    end
+
+    it "returns 404 error if list id not found" do
+      delete api("#{url}/44444", user)
+
+      expect(response).to have_gitlab_http_status(404)
+    end
+
+    context "when the user is parent owner" do
+      set(:owner) { create(:user) }
+
+      before do
+        if board_parent.try(:namespace)
+          board_parent.update(namespace: owner.namespace)
+        else
+          board.parent.add_owner(owner)
+        end
+      end
+
+      it "deletes the list if an admin requests it" do
+        delete api("#{url}/#{dev_list.id}", owner)
+
+        expect(response).to have_gitlab_http_status(204)
+      end
+
+      it_behaves_like '412 response' do
+        let(:request) { api("#{url}/#{dev_list.id}", owner) }
+      end
+    end
+  end
+end