Merge branch 'backport-issue_3413' into 'master'

[EE-backport] Add group boards API endpoint

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

6 files changed, 293 insertions, 168 deletions

diff --git a/spec/finders/labels_finder_spec.rb b/spec/finders/labels_finder_spec.rb
index d507af3fd3d..06031aee217 100644
--- a/spec/finders/labels_finder_spec.rb
+++ b/spec/finders/labels_finder_spec.rb
@@ -56,6 +56,16 @@ describe LabelsFinder do
 
         expect(finder.execute).to eq [group_label_2, group_label_1, project_label_5]
       end
+
+      context 'when only_group_labels is true' do
+        it 'returns only group labels' do
+          group_1.add_developer(user)
+
+          finder = described_class.new(user, group_id: group_1.id, only_group_labels: true)
+
+          expect(finder.execute).to eq [group_label_2, group_label_1]
+        end
+      end
     end
 
     context 'filtering by project_id' do
diff --git a/spec/fixtures/api/schemas/public_api/v4/board.json b/spec/fixtures/api/schemas/public_api/v4/board.json
new file mode 100644
index 00000000000..d667f1d631c
--- /dev/null
+++ b/spec/fixtures/api/schemas/public_api/v4/board.json
@@ -0,0 +1,86 @@
+{
+  "type": "object",
+  "required" : [
+    "id",
+    "project",
+    "lists"
+  ],
+  "properties" : {
+    "id": { "type": "integer" },
+    "project": {
+      "type": ["object", "null"],
+      "required": [
+        "id",
+        "avatar_url",
+        "description",
+        "default_branch",
+        "tag_list",
+        "ssh_url_to_repo",
+        "http_url_to_repo",
+        "web_url",
+        "name",
+        "name_with_namespace",
+        "path",
+        "path_with_namespace",
+        "star_count",
+        "forks_count",
+        "created_at",
+        "last_activity_at"
+      ],
+      "properties": {
+        "id": { "type": "integer" },
+        "avatar_url": { "type": ["string", "null"] },
+        "description": { "type": ["string", "null"] },
+        "default_branch": { "type": ["string", "null"] },
+        "tag_list": { "type": "array" },
+        "ssh_url_to_repo": { "type": "string" },
+        "http_url_to_repo": { "type": "string" },
+        "web_url": { "type": "string" },
+        "name": { "type": "string" },
+        "name_with_namespace": { "type": "string" },
+        "path": { "type": "string" },
+        "path_with_namespace": { "type": "string" },
+        "star_count": { "type": "integer" },
+        "forks_count": { "type": "integer" },
+        "created_at": { "type": "date" },
+        "last_activity_at": { "type": "date" }
+      },
+      "additionalProperties": false
+    },
+    "lists": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required" : [
+          "id",
+          "label",
+          "position"
+        ],
+        "properties" : {
+          "id": { "type": "integer" },
+          "label": {
+            "type": ["object", "null"],
+            "required": [
+              "id",
+              "color",
+              "description",
+              "name"
+            ],
+            "properties": {
+              "id": { "type": "integer" },
+              "color": {
+                "type": "string",
+                "pattern": "^#[0-9A-Fa-f]{3}{1,2}+$"
+              },
+              "description": { "type": ["string", "null"] },
+              "name": { "type": "string" }
+            }
+          },
+          "position": { "type": ["integer", "null"] }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": true
+}
diff --git a/spec/fixtures/api/schemas/public_api/v4/boards.json b/spec/fixtures/api/schemas/public_api/v4/boards.json
new file mode 100644
index 00000000000..117564ef77a
--- /dev/null
+++ b/spec/fixtures/api/schemas/public_api/v4/boards.json
@@ -0,0 +1,4 @@
+{
+  "type": "array",
+  "items": { "$ref": "board.json" }
+}
diff --git a/spec/fixtures/api/schemas/public_api/v4/user/basic.json b/spec/fixtures/api/schemas/public_api/v4/user/basic.json
index 9f69d31971c..bf330d8278c 100644
--- a/spec/fixtures/api/schemas/public_api/v4/user/basic.json
+++ b/spec/fixtures/api/schemas/public_api/v4/user/basic.json
@@ -1,5 +1,5 @@
 {
-  "type": "object",
+  "type": ["object", "null"],
   "required": [
     "id",
     "state",
diff --git a/spec/requests/api/boards_spec.rb b/spec/requests/api/boards_spec.rb
index f65af69dc7f..c6c10025f7f 100644
--- a/spec/requests/api/boards_spec.rb
+++ b/spec/requests/api/boards_spec.rb
@@ -6,18 +6,18 @@ describe API::Boards do
   set(:non_member)  { create(:user) }
   set(:guest)       { create(:user) }
   set(:admin)       { create(:user, :admin) }
-  set(:project)    { create(:project, :public, creator_id: user.id, namespace: user.namespace ) }
+  set(:board_parent) { create(:project, :public, creator_id: user.id, namespace: user.namespace ) }
 
   set(:dev_label) do
-    create(:label, title: 'Development', color: '#FFAABB', project: project)
+    create(:label, title: 'Development', color: '#FFAABB', project: board_parent)
   end
 
   set(:test_label) do
-    create(:label, title: 'Testing', color: '#FFAACC', project: project)
+    create(:label, title: 'Testing', color: '#FFAACC', project: board_parent)
   end
 
   set(:ux_label) do
-    create(:label, title: 'UX', color: '#FF0000', project: project)
+    create(:label, title: 'UX', color: '#FF0000', project: board_parent)
   end
 
   set(:dev_list) do
@@ -28,180 +28,25 @@ describe API::Boards do
     create(:list, label: test_label, position: 2)
   end
 
-  set(:board) do
-    create(:board, project: project, lists: [dev_list, test_list])
-  end
-
-  before do
-    project.add_reporter(user)
-    project.add_guest(guest)
-  end
+  set(:milestone) { create(:milestone, project: board_parent) }
+  set(:board_label) { create(:label, project: board_parent) }
+  set(:board) { create(:board, project: board_parent, lists: [dev_list, test_list]) }
 
-  describe "GET /projects/:id/boards" do
-    let(:base_url) { "/projects/#{project.id}/boards" }
+  it_behaves_like 'group and project boards',  "/projects/:id/boards"
 
-    context "when unauthenticated" do
-      it "returns authentication error" do
-        get api(base_url)
-
-        expect(response).to have_gitlab_http_status(401)
-      end
-    end
-
-    context "when authenticated" do
-      it "returns the project issue board" do
-        get api(base_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(1)
-        expect(json_response.first['id']).to eq(board.id)
-        expect(json_response.first['lists']).to be_an Array
-        expect(json_response.first['lists'].length).to eq(2)
-        expect(json_response.first['lists'].last).to have_key('position')
-      end
-    end
-  end
-
-  describe "GET /projects/:id/boards/:board_id/lists" do
-    let(:base_url) { "/projects/#{project.id}/boards/#{board.id}/lists" }
-
-    it 'returns issue board lists' do
-      get api(base_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("/projects/#{project.id}/boards/22343/lists", user)
-
-      expect(response).to have_gitlab_http_status(404)
-    end
-  end
-
-  describe "GET /projects/:id/boards/:board_id/lists/:list_id" do
-    let(:base_url) { "/projects/#{project.id}/boards/#{board.id}/lists" }
-
-    it 'returns a list' do
-      get api("#{base_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("#{base_url}/5324", user)
-
-      expect(response).to have_gitlab_http_status(404)
-    end
-  end
-
-  describe "POST /projects/:id/board/lists" do
-    let(:base_url) { "/projects/#{project.id}/boards/#{board.id}/lists" }
+  describe "POST /projects/:id/boards/lists" do
+    let(:url) { "/projects/#{board_parent.id}/boards/#{board.id}/lists" }
 
     it 'creates a new issue board list for group labels' do
       group = create(:group)
       group_label = create(:group_label, group: group)
-      project.update(group: group)
+      board_parent.update(group: group)
 
-      post api(base_url, user), label_id: group_label.id
+      post api(url, user), label_id: group_label.id
 
       expect(response).to have_gitlab_http_status(201)
       expect(json_response['label']['name']).to eq(group_label.title)
       expect(json_response['position']).to eq(3)
     end
-
-    it 'creates a new issue board list for project labels' do
-      post api(base_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(base_url, user), label_id: 23423
-
-      expect(response).to have_gitlab_http_status(400)
-    end
-
-    it 'returns 403 for project members with guest role' do
-      put api("#{base_url}/#{test_list.id}", guest), position: 1
-
-      expect(response).to have_gitlab_http_status(403)
-    end
-  end
-
-  describe "PUT /projects/:id/boards/:board_id/lists/:list_id to update only position" do
-    let(:base_url) { "/projects/#{project.id}/boards/#{board.id}/lists" }
-
-    it "updates a list" do
-      put api("#{base_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("#{base_url}/44444", user),
-        position: 1
-
-      expect(response).to have_gitlab_http_status(404)
-    end
-
-    it "returns 403 for project members with guest role" do
-      put api("#{base_url}/#{test_list.id}", guest),
-        position: 1
-
-      expect(response).to have_gitlab_http_status(403)
-    end
-  end
-
-  describe "DELETE /projects/:id/board/lists/:list_id" do
-    let(:base_url) { "/projects/#{project.id}/boards/#{board.id}/lists" }
-
-    it "rejects a non member from deleting a list" do
-      delete api("#{base_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("#{base_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("#{base_url}/44444", user)
-
-      expect(response).to have_gitlab_http_status(404)
-    end
-
-    context "when the user is project owner" do
-      set(:owner) { create(:user) }
-
-      before do
-        project.update(namespace: owner.namespace)
-      end
-
-      it "deletes the list if an admin requests it" do
-        delete api("#{base_url}/#{dev_list.id}", owner)
-
-        expect(response).to have_gitlab_http_status(204)
-      end
-
-      it_behaves_like '412 response' do
-        let(:request) { api("#{base_url}/#{dev_list.id}", owner) }
-      end
-    end
   end
 end
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