Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

Open Booking API Test Suite Feature Coverage

The test coverage below is automatically generated, and indicates which features of the Open Booking API are currently covered by the test suite.

Stub tests are provided in many cases, and test coverage should not be regarded as exhaustive unless specified.

Complete Test Coverage

The tests for these features cover all known edge cases, including both happy and unhappy paths.

Category Feature Specification Description Prerequisites per Opportunity Type
core AgentBroker mode (agent-broker) Required
View Spec
Support for AgentBroker mode TestOpportunityBookable x8
core Amending the OrderQuote before B (amending-order-quote) Required
View Spec
Allows the basket to be updated for a particular order TestOpportunityBookable x32
core Availability Checking (availability-check) Required
View Spec
Runs only C1 and C2, to confirm availability checks work as expected TestOpportunityBookable x5, TestOpportunityBookableNoSpaces x3
core Common error conditions (common-error-conditions) Required
View Spec
Tests C1, C2 and B for common error conditions applicable to all implementations TestOpportunityBookable x29, TestOpportunityBookableInPast x3
core Dataset Site (dataset-site) Required
View Spec
Discoverable open data
core Order Deletion Endpoint (order-deletion) Required
View Spec
Check that Order Deletion correctly soft-deletes an Order that has already been emitted in the Orders feed TestOpportunityBookable x12
access accessChannel - Seller provided remote access (access-channel) Optional
View Spec
For online opportunities, an accessChannel (or a customerNotice indicating that an accessChannel will be sent soon) is provided upon booking with B TestOpportunityOnlineBookable x3, TestOpportunityBookable x1
access accessChannel update notifications (access-channel-update-notifications) Optional
View Spec
When accessChannel changes, make sure this change is supplied back to the Broker via the Orders feed TestOpportunityOnlineBookable x3, TestOpportunityBookable x1
access accessCode - manual access codes (access-code) Optional
View Spec
Support for accessCode provided for a successful booking TestOpportunityOfflineBookable x3, TestOpportunityBookable x1
access accessCode update notifications (access-code-update-notifications) Optional
View Spec
Updating accessCode after an opportunity is booked TestOpportunityOfflineBookable x3, TestOpportunityBookable x1
access accessPass - Seller provided access control barcodes (access-pass-barcode-seller-provided) Optional
View Spec
Support for accessPass provided by the Seller, in the form of a barcode TestOpportunityOfflineBookable x3, TestOpportunityBookable x1
access accessPass - Seller provided access control images (access-pass-image) Optional
View Spec
Support for accessPass provided by the Seller, in the form of an image TestOpportunityOfflineBookable x3, TestOpportunityBookable x1
access accessPass update notifications (access-pass-update-notifications) Optional
View Spec
Updating accessPass after an opportunity is booked TestOpportunityOfflineBookable x3, TestOpportunityBookable x1
approval Minimal Proposal Implementation - Book an opportunity using an OrderProposal (minimal-proposal) Optional
View Spec
Test Minimal Proposal Implementation approval flows. OrderProposal Amendments are not included here. TestOpportunityBookable x16
approval Proposal Amendment - Amend an opportunity using an OrderProposal (proposal-amendment) Optional
View Spec
Test approval flows with Proposal Amendment. TestOpportunityBookableWithNegotiation x3, TestOpportunityBookable x1
authentication Booking Partner Authentication for Multiple Seller Systems (booking-partner-authentication) Optional
View Spec
OAuth based authentication for Sellers
authentication Dynamic Client Registration for Multiple Seller Systems (dynamic-client-registration) Optional
View Spec
For multi-database booking systems where the customer manages Open Booking API client credentials.
broker-role NoBroker mode (no-broker) Optional
View Spec
Support for NoBroker mode, for example for operators to use the Open Booking API to power their own websites TestOpportunityBookable x12
broker-role ResellerBroker mode (reseller-broker) Optional
View Spec
Support for ResellerBroker mode TestOpportunityBookable x12
cancellation latestCancellationBeforeStartDate cancellation window (cancellation-window) Optional
View Spec
A defined window before the event occurs where it can be cancelled without fees TestOpportunityBookableCancellableOutsideWindow x3, TestOpportunityBookable x2, TestOpportunityBookableCancellableWithinWindow x3
cancellation Customer Requested Cancellation (customer-requested-cancellation) Optional
View Spec
Cancellation triggered by the Customer through the Broker TestOpportunityBookableCancellable x18, TestOpportunityBookableNotCancellable x1, TestOpportunityBookable x4
cancellation Customer Requested Cancellation is available for all opportunities (customer-requested-cancellation-always-allowed) Optional
View Spec
This feature should be enabled if Customer Requested Cancellation cannot be disabled by the Seller
cancellation Seller Requested Cancellation (seller-requested-cancellation) Optional
View Spec
Cancellation triggered by the Seller through the Booking System TestOpportunityBookable x4
cancellation cancellationMessage for Seller Requested Cancellation (seller-requested-cancellation-message) Optional
View Spec
A message associated with a Cancellation triggered by the Seller through the Booking System TestOpportunityBookable x4
cancellation Seller Requested Replacement (seller-requested-replacement) Optional
View Spec
Replacement triggered by the Seller through the Booking System TestOpportunityBookable x4
core Multiple Sellers (multiple-sellers) Optional
View Spec
The booking system is multi-tenanted and provides services to multiple sellers. TestOpportunityBookable x6
core Test interface (test-interface) Optional
View Spec
Open Booking API Test Interface implementation TestOpportunityBookable x1
details-capture Additional Details capture (additional-details-capture) Optional
View Spec
Support for capturing additional details with required set to true TestOpportunityBookableAdditionalDetails x9, TestOpportunityBookable x3
details-capture Simple Book including Attendee Details capture (attendee-details-capture) Optional
View Spec
Support for capturing attendee details TestOpportunityBookableAttendeeDetails x6, TestOpportunityBookable x2
details-capture Customer Details identifier capture (customer-details-capture-identifier) Optional
View Spec
Support for capturing the Broker's identifier for the customer. Note this field cannot be mandatory. TestOpportunityBookable x4
details-capture Customer Details non-essential capture (customer-details-capture-non-essential) Optional
View Spec
Support for capturing forename, surname, and telephone number from the Customer. Note these fields cannot be mandatory. TestOpportunityBookable x4
leasing Anonymous leasing, including leaseExpires (anonymous-leasing) Optional
View Spec
Leasing at C1, reserving a space in the opportunity before the Customer has provided their contact information TestOpportunityBookableFiveSpaces x2, TestOpportunityBookableOneSpace x2, TestOpportunityBookable x4
leasing Named leasing, including leaseExpires (named-leasing) Optional
View Spec
Leasing at C2, reserving a space in the opportunity after the Customer has provided their contact information TestOpportunityBookableFiveSpaces x2, TestOpportunityBookableOneSpace x2, TestOpportunityBookable x4
notifications Change of logistics notifications (change-of-logistics-notifications) Optional
View Spec
Notifications for when an opportunity's name, location, or start/end date/time are updated TestOpportunityBookable x12
notifications Customer notice notifications (customer-notice-notifications) Optional
View Spec
Text notifications broadcast to all registered attendees of an opportunity TestOpportunityBookable x4
notifications Opportunity attendance updates (opportunity-attendance-updates) Optional
View Spec
Allowing the broker to recieve updates for when an attendee attends an event TestOpportunityBookable x8
payment Free opportunities (free-opportunities) Optional
View Spec
The most simple form of booking, for free opportunities. Does not check for leases. TestOpportunityBookableFree x10
payment Opportunities with a non-zero price (non-free-opportunities) Optional
View Spec
The most simple form of booking with payment. Does not check for leases. TestOpportunityBookableNonFree x6, TestOpportunityBookable x2
payment Payment reconciliation detail validation (payment-reconciliation-detail-validation) Optional
View Spec
Booking with valid, invalid, and missing Payment details TestOpportunityBookableFree x12, TestOpportunityBookableUsingPayment x15, TestOpportunityBookable x5
payment prepayment optional (prepayment-optional) Optional
View Spec
Support for booking with optional payment TestOpportunityBookableNonFreePrepaymentOptional x8
payment prepayment required (prepayment-required) Optional
View Spec
Support for booking with required payment TestOpportunityBookableNonFreePrepaymentRequired x8
payment prepayment required and unavailable (prepayment-required-unavailable) Optional
View Spec
Booking systems that allow BOTH prepayment required and prepayment unavailable TestOpportunityBookableNonFreePrepaymentRequired x1, TestOpportunityBookableNonFreePrepaymentUnavailable x1
payment prepayment unavailable (prepayment-unavailable) Optional
View Spec
Support for booking without payment (reservation only) TestOpportunityBookableNonFreePrepaymentUnavailable x9, TestOpportunityBookableFree x3
restrictions Booking restrictions (booking-restrictions) Optional
View Spec
Support for genderRestriction, ageRestriction and additionalAdmissionRestriction
restrictions validFromBeforeStartDate booking window (booking-window) Optional
View Spec
Duration of window before an opportunity where it is bookable TestOpportunityBookableWithinValidFromBeforeStartDate x3, TestOpportunityBookable x2, TestOpportunityBookableOutsideValidFromBeforeStartDate x3
tax Business-to-business Tax Calculation (TaxGross) (business-to-business-tax-calculation-gross) Optional
View Spec
Tax calculation when the customer is of type Organization (business-to-business), when the seller has taxMode TaxGross TestOpportunityBookableNonFreeTaxGross x4
tax Business-to-business Tax Calculation (TaxNet) (business-to-business-tax-calculation-net) Optional
View Spec
Tax calculation when the customer is of type Organization (business-to-business), when the seller has taxMode TaxNet TestOpportunityBookableNonFreeTaxNet x4
tax Business-to-consumer Tax Calculation (TaxGross) (business-to-consumer-tax-calculation-gross) Optional
View Spec
Tax calculation when the customer is of type Person (business-to-consumer), when the seller has taxMode TaxGross TestOpportunityBookableNonFreeTaxGross x8
tax Business-to-consumer Tax Calculation (TaxNet) (business-to-consumer-tax-calculation-net) Optional
View Spec
Tax calculation when the customer is of type Person (business-to-consumer), when the seller has taxMode TaxNet TestOpportunityBookableNonFreeTaxNet x4
terms termsOfService without requiresExplicitConsent (terms-of-service-for-booking-system) Optional
View Spec
Displaying terms of service of the Booking System, without requiring consent TestOpportunityBookable x4
terms termsOfService without requiresExplicitConsent (terms-of-service-for-seller) Optional
View Spec
Displaying terms of service of the Seller, without requiring consent TestOpportunityBookableSellerTermsOfService x4

No Test Coverage

The tests for these features are fully stubbed, and are not yet implemented.

Category Feature Specification Description Prerequisites per Opportunity Type
advanced-payment DynamicPayment (dynamic-payment) Optional
View Spec
Support for fully dynamic pricing, where price is not known at the point of purchase
advanced-payment Offer overrides (offer-overrides) Optional
View Spec
Offer prices overridden to allow for business models with variable pricing
broker-role ResellerBroker Business-to-business Tax Calculation (reseller-broker-tax-calculation) Optional
View Spec
Tax calculation for ResellerBroker (business-to-business)
core RPDE Opportunity Feed (opportunity-feed) Optional
View Spec
Real-time opportunity data
terms termsOfService with requiresExplicitConsent (terms-of-service-with-consent) Optional
View Spec
Displaying terms of service that require consent
terms termsOfService with requiresExplicitConsent and dateModified (terms-of-service-with-consent-with-date-modified) Optional
View Spec
Displaying terms of service that require consent, with a date the terms were modified