Module: PlanMyStuff::TestHelpers

Defined in:
lib/plan_my_stuff/test_helpers.rb

Overview

Test support for consuming apps. Provides:

  • ‘PlanMyStuff.test_mode!` to stub all API calls

  • Factory-style builders: ‘build_issue`, `build_comment`, `build_project`

  • RSpec matchers: ‘expect_pms_issue_created`, `expect_pms_comment_created`, `expect_pms_item_moved`

Usage:

require 'plan_my_stuff/test_helpers'

RSpec.configure do |config|
  config.include PlanMyStuff::TestHelpers
end

Defined Under Namespace

Modules: Notifications

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.build_comment(body: 'Test comment', visibility: :public, id: 1, issue: nil, metadata: {}) ⇒ PlanMyStuff::Comment

Builds a fake persisted Comment without hitting the API.

Parameters:

  • body (String) (defaults to: 'Test comment')
  • visibility (Symbol, String) (defaults to: :public)
  • id (Integer) (defaults to: 1)
  • issue (PlanMyStuff::Issue, nil) (defaults to: nil) —

    parent issue (auto-built if nil)

  • metadata (Hash) (defaults to: {}) —

    raw metadata fields to merge

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 84

def build_comment(body: 'Test comment', visibility: :public, id: 1, issue: nil, metadata: {})
  issue ||= build_issue

  comment = PlanMyStuff::Comment.new(
    body: body,
    id: id,
    issue: issue,
  )
  comment.visibility = visibility.to_sym

  comment_metadata = PlanMyStuff::CommentMetadata.from_hash({
    schema_version: PlanMyStuff::BaseMetadata::SCHEMA_VERSION,
    gem_version: PlanMyStuff::VERSION::STRING,
    visibility: visibility.to_s,
    custom_fields: {},
  }.merge(metadata))

  comment.metadata = comment_metadata
  comment.__send__(:persisted!)
  comment
end

.build_issue(title: 'Test Issue', body: 'Test body', state: :open, number: 1, repo: 'TestOrg/TestRepo', labels: [], metadata: {}) ⇒ PlanMyStuff::Issue

Builds a fake persisted Issue without hitting the API.

Parameters:

  • title (String) (defaults to: 'Test Issue')
  • body (String) (defaults to: 'Test body')
  • state (Symbol, String) (defaults to: :open)
  • number (Integer) (defaults to: 1)
  • repo (String) (defaults to: 'TestOrg/TestRepo')
  • labels (Array<String>) (defaults to: [])
  • metadata (Hash) (defaults to: {}) —

    raw metadata fields to merge

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 36

def build_issue(
  title: 'Test Issue',
  body: 'Test body',
  state: :open,
  number: 1,
  repo: 'TestOrg/TestRepo',
  labels: [],
  metadata: {}
)
  issue = PlanMyStuff::Issue.new(
    title: title,
    body: body,
    state: state.to_s,
    number: number,
    repo: repo,
    labels: labels,
  )

  issue_metadata = PlanMyStuff::IssueMetadata.from_hash({
    schema_version: PlanMyStuff::BaseMetadata::SCHEMA_VERSION,
    gem_version: PlanMyStuff::VERSION::STRING,
    visibility: 'public',
    custom_fields: {},
  }.merge(metadata))

  issue.metadata = issue_metadata
  issue.__send__(:persisted!)

  body_comment = build_comment(
    body: body,
    issue: issue,
    metadata: { issue_body: true },
  )
  issue.instance_variable_set(:@comments, [body_comment])

  issue
end

.build_project(title: 'Test Project', number: 1, statuses: [], items: []) ⇒ PlanMyStuff::Project

Builds a fake persisted Project without hitting the API.

Parameters:

  • title (String) (defaults to: 'Test Project')
  • number (Integer) (defaults to: 1)
  • statuses (Array<String>) (defaults to: []) —

    status names (auto-assigned IDs)

  • items (Array<Hash>) (defaults to: []) —

    item data hashes

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 115

def build_project(title: 'Test Project', number: 1, statuses: [], items: [])
  status_options = statuses.each_with_index.map do |name, i|
    { id: "status_option_#{i}", name: name }
  end

  project = PlanMyStuff::Project.new(
    id: "PVT_fake_#{number}",
    number: number,
    title: title,
    statuses: status_options,
    fields: [{ id: 'field_status', name: 'Status', options: status_options }],
  )
  project.__send__(:persisted!)

  project.items = items.map do |item_hash|
    PlanMyStuff::ProjectItem.build(
      {
        id: item_hash[:id] || "PVTI_fake_#{rand(10_000)}",
        title: item_hash[:title] || 'Untitled',
        number: item_hash[:number],
        url: item_hash[:url],
        state: item_hash[:state],
        status: item_hash[:status],
        field_values: item_hash[:field_values] || {},
      },
      project: project,
    )
  end

  project
end

.extract_user_id(user) ⇒ Integer

Returns:

  • (Integer) 


167
168
169
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 167

def extract_user_id(user)
  user.is_a?(Integer) ? user : PlanMyStuff::UserResolver.user_id(user)
end

.stub_approvals(issue, approved: [], pending: []) ⇒ Array<PlanMyStuff::Approval>

Sets approvals on an in-memory Issue without hitting the API. Accepts user objects or integer user_ids.

Parameters:

  • issue (PlanMyStuff::Issue)
  • approved (Array<Object, Integer>) (defaults to: []) —

    approvers who have approved

  • pending (Array<Object, Integer>) (defaults to: []) —

    approvers who have not yet approved

Returns:



156
157
158
159
160
161
162
163
164
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 156

def stub_approvals(issue, approved: [], pending: [])
  records =
    pending.map { |u| PlanMyStuff::Approval.new(user_id: extract_user_id(u), status: 'pending') } +
    approved.map do |u|
      PlanMyStuff::Approval.new(user_id: extract_user_id(u), status: 'approved', approved_at: Time.current)
    end
  issue.metadata.approvals = records
  records
end

Instance Method Details

#expect_pms_comment_created(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. issue_number:, visibility:)



230
231
232
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 230

def expect_pms_comment_created(**filters)
  expect_pms_action(:comment_created, 'comment to be created', **filters)
end

#expect_pms_comment_updated(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. id:, body:)



240
241
242
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 240

def expect_pms_comment_updated(**filters)
  expect_pms_action(:comment_updated, 'comment to be updated', **filters)
end

#expect_pms_comments_listed(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. issue_number:, pms_only:)



235
236
237
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 235

def expect_pms_comments_listed(**filters)
  expect_pms_action(:comments_listed, 'comments to be listed', **filters)
end

#expect_pms_issue_created(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. repo:, title:)



200
201
202
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 200

def expect_pms_issue_created(**filters)
  expect_pms_action(:issue_created, 'issue to be created', **filters)
end

#expect_pms_issue_found(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. number:, repo:)



205
206
207
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 205

def expect_pms_issue_found(**filters)
  expect_pms_action(:issue_found, 'issue to be found', **filters)
end

#expect_pms_issue_updated(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. number:, state:)



215
216
217
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 215

def expect_pms_issue_updated(**filters)
  expect_pms_action(:issue_updated, 'issue to be updated', **filters)
end

#expect_pms_issues_listed(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters



210
211
212
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 210

def expect_pms_issues_listed(**filters)
  expect_pms_action(:issues_listed, 'issues to be listed', **filters)
end

#expect_pms_item_assigned(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. project:, assignee:)



265
266
267
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 265

def expect_pms_item_assigned(**filters)
  expect_pms_action(:item_assigned, 'item to be assigned', **filters)
end

#expect_pms_item_created(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. project:, title:)



260
261
262
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 260

def expect_pms_item_created(**filters)
  expect_pms_action(:item_created, 'item to be created', **filters)
end

#expect_pms_item_moved(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. project:, status:)



255
256
257
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 255

def expect_pms_item_moved(**filters)
  expect_pms_action(:item_moved, 'item to be moved', **filters)
end

#expect_pms_pipeline_deployment_completed(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. item_id:, deployment_id:)



300
301
302
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 300

def expect_pms_pipeline_deployment_completed(**filters)
  expect_pms_action(:pipeline_deployment_completed, 'pipeline deployment completed', **filters)
end

#expect_pms_pipeline_deployment_started(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. project_number:, commit_sha:)



295
296
297
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 295

def expect_pms_pipeline_deployment_started(**filters)
  expect_pms_action(:pipeline_deployment_started, 'pipeline deployment started', **filters)
end

#expect_pms_pipeline_in_review(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. item_id:)



280
281
282
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 280

def expect_pms_pipeline_in_review(**filters)
  expect_pms_action(:pipeline_in_review, 'pipeline item marked in review', **filters)
end

#expect_pms_pipeline_ready_for_release(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. item_id:)



290
291
292
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 290

def expect_pms_pipeline_ready_for_release(**filters)
  expect_pms_action(:pipeline_ready_for_release, 'pipeline item marked ready for release', **filters)
end

#expect_pms_pipeline_submitted(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. assignee:, project_number:)



270
271
272
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 270

def expect_pms_pipeline_submitted(**filters)
  expect_pms_action(:pipeline_submitted, 'pipeline submission', **filters)
end

#expect_pms_pipeline_taken(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. item_id:)



275
276
277
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 275

def expect_pms_pipeline_taken(**filters)
  expect_pms_action(:pipeline_started, 'pipeline item to be taken', **filters)
end

#expect_pms_pipeline_testing(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. item_id:)



285
286
287
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 285

def expect_pms_pipeline_testing(**filters)
  expect_pms_action(:pipeline_testing, 'pipeline item moved to testing', **filters)
end

#expect_pms_project_found(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. number:)



250
251
252
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 250

def expect_pms_project_found(**filters)
  expect_pms_action(:project_found, 'project to be found', **filters)
end

#expect_pms_projects_listed(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters



245
246
247
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 245

def expect_pms_projects_listed(**filters)
  expect_pms_action(:projects_listed, 'projects to be listed', **filters)
end

#expect_pms_viewers_added(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. number:, user_ids:)



220
221
222
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 220

def expect_pms_viewers_added(**filters)
  expect_pms_action(:viewers_added, 'viewers to be added', **filters)
end

#expect_pms_viewers_removed(**filters) ⇒ Object

Parameters:

  • filters (Hash) —

    attribute filters (e.g. number:, user_ids:)



225
226
227
 
# File 'lib/plan_my_stuff/test_helpers.rb', line 225

def expect_pms_viewers_removed(**filters)
  expect_pms_action(:viewers_removed, 'viewers to be removed', **filters)
end