Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Pact tests #1293

Merged
merged 2 commits into from
Nov 13, 2024
Merged

Fix Pact tests #1293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6de802
Fix Pact tests
pezholio Nov 13, 2024
69611a4
Update Changelog
pezholio Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## Unreleased

* Add new args to get_content_by_embedded_document [PR](https://github.com/alphagov/gds-api-adapters/pull/1291)

## 97.1.0

* Add GraphQL endpoint for Publishing API [PR](https://github.com/alphagov/gds-api-adapters/pull/1290)
Expand Down
154 changes: 110 additions & 44 deletions test/pacts/publishing_api/get_embedded_content_pact_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,24 @@
let(:reusable_content_id) { "bed722e6-db68-43e5-9079-063f623335a7" }
let(:content_id) { "d66d6552-2627-4451-9dbc-cadbbd2005a1" }
let(:publishing_organisation_content_id) { "d1e7d343-9844-4246-a469-1fa4640e12ad" }
let(:result) do
{
"title" => "foo",
"base_path" => "/foo",
"document_type" => "publication",
"publishing_app" => "publisher",
"primary_publishing_organisation" => {
"content_id" => publishing_organisation_content_id,
"title" => "bar",
"base_path" => "/bar",
},
}
end
let(:expected_body) do
{
"content_id" => reusable_content_id,
"total" => 1,
"results" => [
{
"title" => "foo",
"base_path" => "/foo",
"document_type" => "publication",
"publishing_app" => "publisher",
"primary_publishing_organisation" => {
"content_id" => publishing_organisation_content_id,
"title" => "bar",
"base_path" => "/bar",
},
},
],
"results" => [result],
}
end

Expand All @@ -47,42 +48,107 @@
assert_equal(expected_body, response.parsed_content)
end

it "supports pagination" do
publishing_api
.given("a content item exists (content_id: #{content_id}) that embeds the reusable content (content_id: #{reusable_content_id})")
.upon_receiving("a get_content_by_embedded_document request with pagination")
.with(
method: :get,
path: "/v2/content/#{reusable_content_id}/embedded",
query: "page=2",
)
.will_respond_with(
status: 200,
body: expected_body,
)
describe "there are multiple pages" do
let(:publishing_api_with_multiple_content_items) do
publishing_api.given("multiple content items exist that embed the reusable content (content_id: #{reusable_content_id})")
end

response = api_client.get_content_by_embedded_document(reusable_content_id, { page: 2 })
let(:result) do
{
"title" => "foo",
"base_path" => "/foo",
"document_type" => "publication",
"publishing_app" => "publisher",
"primary_publishing_organisation" => {
"content_id" => nil,
"title" => nil,
"base_path" => nil,
},
}
end

assert_equal(expected_body, response.parsed_content)
end
it "returns the first page of results" do
publishing_api_with_multiple_content_items
.upon_receiving("a get_content_by_embedded_document request for multiple pages")
.with(
method: :get,
path: "/v2/content/#{reusable_content_id}/embedded",
)
.will_respond_with(
status: 200,
body: {
"content_id" => reusable_content_id,
"total" => 12,
"total_pages" => 2,
"results" => Pact.each_like(result, min: 10),
},
)

it "supports sorting" do
publishing_api
.given("a content item exists (content_id: #{content_id}) that embeds the reusable content (content_id: #{reusable_content_id})")
.upon_receiving("a get_content_by_embedded_document request with sorting")
.with(
method: :get,
path: "/v2/content/#{reusable_content_id}/embedded",
query: "order=-last_edited_at",
)
.will_respond_with(
status: 200,
body: expected_body,
)
api_client.get_content_by_embedded_document(reusable_content_id)
end

response = api_client.get_content_by_embedded_document(reusable_content_id, { order: "-last_edited_at" })
it "supports a page argument" do
publishing_api_with_multiple_content_items
.upon_receiving("a get_content_by_embedded_document request for multiple pages with a page argument")
.with(
method: :get,
path: "/v2/content/#{reusable_content_id}/embedded",
query: "page=2",
)
.will_respond_with(
status: 200,
body: {
"content_id" => reusable_content_id,
"total" => 12,
"total_pages" => 2,
"results" => Pact.each_like(result, min: 2),
},
)

assert_equal(expected_body, response.parsed_content)
api_client.get_content_by_embedded_document(reusable_content_id, { page: 2 })
end

it "supports a per page argument" do
publishing_api_with_multiple_content_items
.upon_receiving("a get_content_by_embedded_document request for multiple pages with a per_page argument")
.with(
method: :get,
path: "/v2/content/#{reusable_content_id}/embedded",
query: "per_page=1",
)
.will_respond_with(
status: 200,
body: {
"content_id" => reusable_content_id,
"total" => 12,
"total_pages" => 12,
"results" => Pact.each_like(result, min: 1),
},
)

api_client.get_content_by_embedded_document(reusable_content_id, { per_page: 1 })
end

it "supports sorting" do
publishing_api_with_multiple_content_items
.upon_receiving("a get_content_by_embedded_document request for multiple pages with sorting")
.with(
method: :get,
path: "/v2/content/#{reusable_content_id}/embedded",
query: "order=-last_edited_at",
)
.will_respond_with(
status: 200,
body: {
"content_id" => reusable_content_id,
"total" => 12,
"total_pages" => 2,
"results" => Pact.each_like(result, min: 10),
},
)

api_client.get_content_by_embedded_document(reusable_content_id, { order: "-last_edited_at" })
end
end

it "responds with 404 if the content item does not exist" do
Expand Down