Rename let binding in GraphQL shared_example

Renames expected_results to all_records for clarity

doc/development/graphql_guide/pagination.md

@@ -340,7 +340,7 @@ describe 'sorting and pagination' do
       it_behaves_like 'sorted paginated query' do
         let(:sort_param) { :WEIGHT_ASC }
         let(:first_param) { 2 }
-        let(:expected_results) { ordered_issues.map(&:iid) }
+        let(:all_records) { ordered_issues.map(&:iid) }
       end
     end
   end

ee/spec/requests/api/graphql/boards/board_lists_query_spec.rb

@@ -92,7 +92,7 @@ RSpec.describe 'get board lists' do
             it_behaves_like 'sorted paginated query' do
               let(:sort_param) { }
               let(:first_param) { 2 }
-              let(:expected_results) { lists.map { |list| global_id_of(list) } }
+              let(:all_records) { lists.map { |list| global_id_of(list) } }
             end
           end
         end

ee/spec/requests/api/graphql/boards/epic_board_list_epics_query_spec.rb

@@ -43,7 +43,7 @@ RSpec.describe 'get list of epics for an epic  board list' do
 
   describe 'sorting and pagination' do
     let(:epic_fields) { all_graphql_fields_for('epics'.classify) }
-    let(:expected_results) { [epic2.to_global_id.to_s, epic1.to_global_id.to_s, epic3.to_global_id.to_s] }
+    let(:all_records) { [epic2.to_global_id.to_s, epic1.to_global_id.to_s, epic3.to_global_id.to_s] }
 
     def pagination_results_data(nodes)
       nodes.map { |list| list['id'] }

ee/spec/requests/api/graphql/boards/epic_boards_query_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe 'get list of epic boards' do
 
     describe 'sorting and pagination' do
       let(:data_path) { [:group, :epicBoards] }
-      let(:expected_results) { [board2.to_global_id.to_s, board3.to_global_id.to_s, board1.to_global_id.to_s] }
+      let(:all_records) { [board2.to_global_id.to_s, board3.to_global_id.to_s, board1.to_global_id.to_s] }
 
       def pagination_results_data(nodes)
         nodes.map { |board| board['id'] }

ee/spec/requests/api/graphql/boards/epic_lists_query_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe 'get list of epic boards' do
 
     describe 'sorting and pagination' do
       let(:data_path) { [:group, :epicBoard, :lists] }
-      let(:expected_results) { [list3.to_global_id.to_s, list1.to_global_id.to_s, list2.to_global_id.to_s] }
+      let(:all_records) { [list3.to_global_id.to_s, list1.to_global_id.to_s, list2.to_global_id.to_s] }
 
       def pagination_results_data(nodes)
         nodes.map { |list| list['id'] }

ee/spec/requests/api/graphql/group/epic/epic_issues_spec.rb

@@ -89,7 +89,7 @@ RSpec.describe 'Getting issues for an epic' do
           let(:current_user) { user }
           let(:sort_param) { }
           let(:first_param) { 1 }
-          let(:expected_results) { [issue, confidential_issue].map { |i| global_id_of(i) } }
+          let(:all_records) { [issue, confidential_issue].map { |i| global_id_of(i) } }
         end
       end
     end

ee/spec/requests/api/graphql/group/epics_spec.rb

@@ -99,7 +99,7 @@ RSpec.describe 'Epics through GroupQuery' do
           it_behaves_like 'sorted paginated query', is_reversible: true do
             let(:sort_param) { :start_date_asc }
             let(:first_param) { 2 }
-            let(:expected_results) { global_ids(epic4, epic3, epic2, epic) }
+            let(:all_records) { global_ids(epic4, epic3, epic2, epic) }
           end
         end
 
@@ -107,7 +107,7 @@ RSpec.describe 'Epics through GroupQuery' do
           it_behaves_like 'sorted paginated query', is_reversible: true do
             let(:sort_param) { :start_date_desc }
             let(:first_param) { 2 }
-            let(:expected_results) { global_ids(epic, epic2, epic3, epic4) }
+            let(:all_records) { global_ids(epic, epic2, epic3, epic4) }
           end
         end
 
@@ -115,7 +115,7 @@ RSpec.describe 'Epics through GroupQuery' do
           it_behaves_like 'sorted paginated query', is_reversible: true do
             let(:sort_param) { :end_date_asc }
             let(:first_param) { 2 }
-            let(:expected_results) { global_ids(epic3, epic4, epic, epic2) }
+            let(:all_records) { global_ids(epic3, epic4, epic, epic2) }
           end
         end
 
@@ -123,7 +123,7 @@ RSpec.describe 'Epics through GroupQuery' do
           it_behaves_like 'sorted paginated query', is_reversible: true do
             let(:sort_param) { :end_date_desc }
             let(:first_param) { 2 }
-            let(:expected_results) { global_ids(epic2, epic, epic4, epic3) }
+            let(:all_records) { global_ids(epic2, epic, epic4, epic3) }
           end
         end
       end

ee/spec/requests/api/graphql/group_query_spec.rb

@@ -367,7 +367,7 @@ RSpec.describe 'getting group information' do
         let(:node_path) { ['averageCoverage'] }
         let(:sort_param) { }
         let(:first_param) { 2 }
-        let(:expected_results) { [cov_1, cov_2, cov_3, cov_4, cov_5].reverse.map(&:coverage) }
+        let(:all_records) { [cov_1, cov_2, cov_3, cov_4, cov_5].reverse.map(&:coverage) }
       end
     end
   end

ee/spec/requests/api/graphql/namespace/projects_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe 'Namespace.projects' do
         let(:node_path) { %w[name] }
         let(:sort_param) { :STORAGE }
         let(:first_param) { 2 }
-        let(:expected_results) { [project_4, project_2, project_3].map(&:name) }
+        let(:all_records) { [project_4, project_2, project_3].map(&:name) }
       end
     end
   end

ee/spec/requests/api/graphql/project/dast_profiles_spec.rb

@@ -69,7 +69,7 @@ RSpec.describe 'Query.project(fullPath).dastProfiles' do
       let(:sort_param) { nil }
       let(:first_param) { 3 }
 
-      let(:expected_results) do
+      let(:all_records) do
         [dast_profile4, dast_profile3, dast_profile2, dast_profile1].map { |validation| global_id_of(validation)}
       end
     end

ee/spec/requests/api/graphql/project/dast_site_validations_spec.rb

@@ -71,7 +71,7 @@ RSpec.describe 'Query.project(fullPath).dastSiteValidations' do
       let(:sort_param) { nil }
       let(:first_param) { 3 }
 
-      let(:expected_results) do
+      let(:all_records) do
         [
           dast_site_validation4,
           dast_site_validation3,

ee/spec/requests/api/graphql/project/issues_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe 'getting an issue list for a project' do
           let(:node_path) { %w[iid] }
           let(:sort_param) { :WEIGHT_ASC }
           let(:first_param) { 2 }
-          let(:expected_results) { [weight_issue3, weight_issue5, weight_issue1, weight_issue4, weight_issue2].map { |i| i.iid.to_s } }
+          let(:all_records) { [weight_issue3, weight_issue5, weight_issue1, weight_issue4, weight_issue2].map { |i| i.iid.to_s } }
         end
       end
 
@@ -38,7 +38,7 @@ RSpec.describe 'getting an issue list for a project' do
           let(:node_path) { %w[iid] }
           let(:sort_param) { :WEIGHT_DESC }
           let(:first_param) { 2 }
-          let(:expected_results) { [weight_issue1, weight_issue5, weight_issue3, weight_issue4, weight_issue2].map { |i| i.iid.to_s } }
+          let(:all_records) { [weight_issue1, weight_issue5, weight_issue3, weight_issue4, weight_issue2].map { |i| i.iid.to_s } }
         end
       end
     end

ee/spec/requests/api/graphql/project/requirements_management/requirements_spec.rb

@@ -208,7 +208,7 @@ RSpec.describe 'getting a requirement list for a project' do
           it_behaves_like 'sorted paginated query' do
             let(:sort_param) { :CREATED_ASC }
             let(:first_param) { 2 }
-            let(:expected_results) { [requirement4.iid, requirement3.iid, requirement5.iid, requirement1.iid, requirement2.iid] }
+            let(:all_records) { [requirement4.iid, requirement3.iid, requirement5.iid, requirement1.iid, requirement2.iid] }
           end
         end
 
@@ -216,7 +216,7 @@ RSpec.describe 'getting a requirement list for a project' do
           it_behaves_like 'sorted paginated query' do
             let(:sort_param) { :CREATED_DESC }
             let(:first_param) { 2 }
-            let(:expected_results) { [requirement2.iid, requirement1.iid, requirement5.iid, requirement3.iid, requirement4.iid] }
+            let(:all_records) { [requirement2.iid, requirement1.iid, requirement5.iid, requirement3.iid, requirement4.iid] }
           end
         end
       end

ee/spec/requests/api/graphql/project/requirements_management/test_reports_spec.rb

@@ -55,8 +55,8 @@ RSpec.describe 'getting test reports of a requirement' do
       post_graphql(query, current_user: current_user)
 
       test_reports_ids = test_reports_data.map { |result| result['node']['id'] }
-      expected_results = [test_report_1.to_global_id.to_s, test_report_2.to_global_id.to_s]
-      expect(test_reports_ids).to match_array(expected_results)
+      all_records = [test_report_1.to_global_id.to_s, test_report_2.to_global_id.to_s]
+      expect(test_reports_ids).to match_array(all_records)
     end
 
     context 'with pagination' do
@@ -76,7 +76,7 @@ RSpec.describe 'getting test reports of a requirement' do
       it_behaves_like 'sorted paginated query' do
         let(:sort_param)       { :CREATED_ASC }
         let(:first_param)      { 2 }
-        let(:expected_results) do
+        let(:all_records) do
           in_creation_order.map { |r| global_id_of(r) }
         end
       end
@@ -84,7 +84,7 @@ RSpec.describe 'getting test reports of a requirement' do
       it_behaves_like 'sorted paginated query' do
         let(:sort_param)       { :CREATED_DESC }
         let(:first_param)      { 2 }
-        let(:expected_results) do
+        let(:all_records) do
           in_creation_order.reverse.map { |r| global_id_of(r) }
         end
       end

spec/requests/api/graphql/boards/board_lists_query_spec.rb

@@ -94,7 +94,7 @@ RSpec.describe 'get board lists' do
             it_behaves_like 'sorted paginated query' do
               let(:sort_param) { }
               let(:first_param) { 2 }
-              let(:expected_results) { lists.map { |list| global_id_of(list) } }
+              let(:all_records) { lists.map { |list| global_id_of(list) } }
             end
           end
         end

spec/requests/api/graphql/ci/runners_spec.rb

@@ -97,7 +97,7 @@ RSpec.describe 'Query.runners' do
       it_behaves_like 'sorted paginated query' do
         let(:sort_param) { :CONTACTED_ASC }
         let(:first_param) { 2 }
-        let(:expected_results) { ordered_runners.map(&:id) }
+        let(:all_records) { ordered_runners.map(&:id) }
       end
     end
 
@@ -107,7 +107,7 @@ RSpec.describe 'Query.runners' do
       it_behaves_like 'sorted paginated query' do
         let(:sort_param) { :CREATED_DESC }
         let(:first_param) { 2 }
-        let(:expected_results) { ordered_runners.map(&:id) }
+        let(:all_records) { ordered_runners.map(&:id) }
       end
     end
   end

spec/requests/api/graphql/namespace/projects_spec.rb

@@ -109,7 +109,7 @@ RSpec.describe 'getting projects' do
         let(:node_path) { %w[name] }
         let(:sort_param) { :SIMILARITY }
         let(:first_param) { 2 }
-        let(:expected_results) { [project_3.name, project_2.name, project_4.name] }
+        let(:all_records) { [project_3.name, project_2.name, project_4.name] }
       end
     end
   end

spec/requests/api/graphql/project/container_repositories_spec.rb

@@ -190,7 +190,7 @@ RSpec.describe 'getting container repositories in a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :NAME_ASC }
           let(:first_param) { 2 }
-          let(:expected_results) { [container_repository2.name, container_repository1.name, container_repository4.name, container_repository3.name, container_repository5.name] }
+          let(:all_records) { [container_repository2.name, container_repository1.name, container_repository4.name, container_repository3.name, container_repository5.name] }
         end
       end
 
@@ -198,7 +198,7 @@ RSpec.describe 'getting container repositories in a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :NAME_DESC }
           let(:first_param) { 2 }
-          let(:expected_results) { [container_repository5.name, container_repository3.name, container_repository4.name, container_repository1.name, container_repository2.name] }
+          let(:all_records) { [container_repository5.name, container_repository3.name, container_repository4.name, container_repository1.name, container_repository2.name] }
         end
       end
     end

spec/requests/api/graphql/project/issues_spec.rb

@@ -205,7 +205,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param)       { :DUE_DATE_ASC }
           let(:first_param)      { 2 }
-          let(:expected_results) { [due_issue3.iid, due_issue5.iid, due_issue1.iid, due_issue4.iid, due_issue2.iid] }
+          let(:all_records) { [due_issue3.iid, due_issue5.iid, due_issue1.iid, due_issue4.iid, due_issue2.iid] }
         end
       end
 
@@ -213,7 +213,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param)       { :DUE_DATE_DESC }
           let(:first_param)      { 2 }
-          let(:expected_results) { [due_issue1.iid, due_issue5.iid, due_issue3.iid, due_issue4.iid, due_issue2.iid] }
+          let(:all_records) { [due_issue1.iid, due_issue5.iid, due_issue3.iid, due_issue4.iid, due_issue2.iid] }
         end
       end
     end
@@ -230,7 +230,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param)       { :RELATIVE_POSITION_ASC }
           let(:first_param)      { 2 }
-          let(:expected_results) do
+          let(:all_records) do
             [
               relative_issue5.iid, relative_issue3.iid, relative_issue1.iid,
               relative_issue4.iid, relative_issue2.iid
@@ -256,7 +256,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param)       { :PRIORITY_ASC }
           let(:first_param)      { 2 }
-          let(:expected_results) do
+          let(:all_records) do
             [
               priority_issue3.iid, priority_issue1.iid,
               priority_issue2.iid, priority_issue4.iid
@@ -269,7 +269,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param)       { :PRIORITY_DESC }
           let(:first_param)      { 2 }
-          let(:expected_results) do
+          let(:all_records) do
             [priority_issue1.iid, priority_issue3.iid, priority_issue2.iid, priority_issue4.iid]
           end
         end
@@ -290,7 +290,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :LABEL_PRIORITY_ASC }
           let(:first_param) { 2 }
-          let(:expected_results) { [label_issue3.iid, label_issue1.iid, label_issue2.iid, label_issue4.iid] }
+          let(:all_records) { [label_issue3.iid, label_issue1.iid, label_issue2.iid, label_issue4.iid] }
         end
       end
 
@@ -298,7 +298,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :LABEL_PRIORITY_DESC }
           let(:first_param) { 2 }
-          let(:expected_results) { [label_issue2.iid, label_issue3.iid, label_issue1.iid, label_issue4.iid] }
+          let(:all_records) { [label_issue2.iid, label_issue3.iid, label_issue1.iid, label_issue4.iid] }
         end
       end
     end
@@ -315,7 +315,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :MILESTONE_DUE_ASC }
           let(:first_param) { 2 }
-          let(:expected_results) { [milestone_issue2.iid, milestone_issue3.iid, milestone_issue1.iid] }
+          let(:all_records) { [milestone_issue2.iid, milestone_issue3.iid, milestone_issue1.iid] }
         end
       end
 
@@ -323,7 +323,7 @@ RSpec.describe 'getting an issue list for a project' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :MILESTONE_DUE_DESC }
           let(:first_param) { 2 }
-          let(:expected_results) { [milestone_issue3.iid, milestone_issue2.iid, milestone_issue1.iid] }
+          let(:all_records) { [milestone_issue3.iid, milestone_issue2.iid, milestone_issue1.iid] }
         end
       end
     end

spec/requests/api/graphql/project/merge_requests_spec.rb

@@ -385,7 +385,7 @@ RSpec.describe 'getting merge request listings nested in a project' do
 
     context 'when sorting by merged_at DESC' do
       let(:sort_param) { :MERGED_AT_DESC }
-      let(:expected_results) do
+      let(:all_records) do
         [
           merge_request_b,
           merge_request_d,
@@ -418,14 +418,14 @@ RSpec.describe 'getting merge request listings nested in a project' do
           query = pagination_query(params)
           post_graphql(query, current_user: current_user)
 
-          expect(results.map { |item| item["id"] }).to eq(expected_results.last(2))
+          expect(results.map { |item| item["id"] }).to eq(all_records.last(2))
         end
       end
     end
 
     context 'when sorting by closed_at DESC' do
       let(:sort_param) { :CLOSED_AT_DESC }
-      let(:expected_results) do
+      let(:all_records) do
         [
           merge_request_b,
           merge_request_d,
@@ -458,7 +458,7 @@ RSpec.describe 'getting merge request listings nested in a project' do
           query = pagination_query(params)
           post_graphql(query, current_user: current_user)
 
-          expect(results.map { |item| item["id"] }).to eq(expected_results.last(2))
+          expect(results.map { |item| item["id"] }).to eq(all_records.last(2))
         end
       end
     end

spec/requests/api/graphql/project/releases_spec.rb

@@ -324,7 +324,7 @@ RSpec.describe 'Query.project(fullPath).releases()' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :RELEASED_AT_ASC }
           let(:first_param) { 2 }
-          let(:expected_results) { [release1.tag, release2.tag, release3.tag, release4.tag, release5.tag] }
+          let(:all_records) { [release1.tag, release2.tag, release3.tag, release4.tag, release5.tag] }
         end
       end
 
@@ -332,7 +332,7 @@ RSpec.describe 'Query.project(fullPath).releases()' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :RELEASED_AT_DESC }
           let(:first_param) { 2 }
-          let(:expected_results) { [release5.tag, release4.tag, release3.tag, release2.tag, release1.tag] }
+          let(:all_records) { [release5.tag, release4.tag, release3.tag, release2.tag, release1.tag] }
         end
       end
     end
@@ -348,7 +348,7 @@ RSpec.describe 'Query.project(fullPath).releases()' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :CREATED_ASC }
           let(:first_param) { 2 }
-          let(:expected_results) { [release1.tag, release2.tag, release3.tag, release4.tag, release5.tag] }
+          let(:all_records) { [release1.tag, release2.tag, release3.tag, release4.tag, release5.tag] }
         end
       end
 
@@ -356,7 +356,7 @@ RSpec.describe 'Query.project(fullPath).releases()' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :CREATED_DESC }
           let(:first_param) { 2 }
-          let(:expected_results) { [release5.tag, release4.tag, release3.tag, release2.tag, release1.tag] }
+          let(:all_records) { [release5.tag, release4.tag, release3.tag, release2.tag, release1.tag] }
         end
       end
     end

spec/requests/api/graphql/users_spec.rb

@@ -116,7 +116,7 @@ RSpec.describe 'Users' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :CREATED_ASC }
           let(:first_param) { 1 }
-          let(:expected_results) { ascending_users }
+          let(:all_records) { ascending_users }
         end
       end
 
@@ -124,7 +124,7 @@ RSpec.describe 'Users' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { :CREATED_DESC }
           let(:first_param) { 1 }
-          let(:expected_results) { ascending_users.reverse }
+          let(:all_records) { ascending_users.reverse }
         end
       end
     end

spec/support/shared_examples/graphql/sorted_paginated_query_shared_examples.rb

@@ -9,7 +9,7 @@
 # data_path: the keys necessary to dig into the return GraphQL data to get the
 #   returned results
 # first_param: number of items expected (like a page size)
-# expected_results: array of comparison data of all items sorted correctly
+# all_records: array of comparison data of all items sorted correctly
 # pagination_query: method that specifies the GraphQL query
 # pagination_results_data: method that extracts the sorted data used to compare against
 #   the expected results
@@ -40,7 +40,7 @@
 #         it_behaves_like 'sorted paginated query' do
 #           let(:sort_param) { :WEIGHT_ASC }
 #           let(:first_param) { 2 }
-#           let(:expected_results) { ordered_issues.map(&:iid) }
+#           let(:all_records) { ordered_issues.map(&:iid) }
 #         end
 #       end
 #
@@ -51,7 +51,7 @@ RSpec.shared_examples 'sorted paginated query' do |conditions = {}|
   let(:node_path) { ['id'] }
 
   it_behaves_like 'requires variables' do
-    let(:required_variables) { [:sort_param, :first_param, :expected_results, :data_path, :current_user] }
+    let(:required_variables) { [:sort_param, :first_param, :all_records, :data_path, :current_user] }
   end
 
   describe do
@@ -101,13 +101,13 @@ RSpec.shared_examples 'sorted paginated query' do |conditions = {}|
 
     context 'when sorting' do
       it 'sorts correctly' do
-        expect(results).to eq expected_results
+        expect(results).to eq all_records
       end
 
       context 'when paginating' do
         let(:params) { sort_argument.merge(first: first_param) }
-        let(:first_page) { expected_results.first(first_param) }
-        let(:rest) { expected_results.drop(first_param) }
+        let(:first_page) { all_records.first(first_param) }
+        let(:rest) { all_records.drop(first_param) }
 
         it 'paginates correctly' do
           expect(results).to eq first_page
@@ -130,7 +130,7 @@ RSpec.shared_examples 'sorted paginated query' do |conditions = {}|
         it 'fetches last elements without error' do
           post_graphql(pagination_query(params), current_user: current_user)
 
-          expect(results.first).to eq(expected_results.last)
+          expect(results.first).to eq(all_records.last)
         end
       end
     end

spec/support/shared_examples/requests/api/graphql/group_and_project_boards_query_shared_examples.rb

@@ -64,7 +64,8 @@ RSpec.shared_examples 'group and project boards query' do
           it_behaves_like 'sorted paginated query' do
             let(:sort_param) { }
             let(:first_param) { 2 }
-            let(:expected_results) do
+
+            let(:all_records) do
               if board_parent.multiple_issue_boards_available?
                 boards.map { |board| global_id_of(board) }
               else

spec/support/shared_examples/requests/api/graphql/packages/group_and_project_packages_list_shared_examples.rb

@@ -95,7 +95,7 @@ RSpec.shared_examples 'group and project packages query' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { order }
           let(:first_param) { 4 }
-          let(:expected_results) { ascending_packages }
+          let(:all_records) { ascending_packages }
         end
       end
     end
@@ -105,7 +105,7 @@ RSpec.shared_examples 'group and project packages query' do
         it_behaves_like 'sorted paginated query' do
           let(:sort_param) { order }
           let(:first_param) { 4 }
-          let(:expected_results) { ascending_packages.reverse }
+          let(:all_records) { ascending_packages.reverse }
         end
       end
     end