Random Mode: Generating Test Opportunity Data

This page is only for those who are using Random Mode to test their booking systems. If instead using Controlled Mode, you don't need to worry about manually generating data, as Test Suite will automatically do this by calling your booking system's Create Opportunity Endpoint.

In Random Mode, Test Suite requires test opportunity data to already exist, which it will use to run tests.

Running Test Suite will cause test opportunities to be booked, and therefore to eventually not be available to subsequent Test Suite runs. And so, this test opportunity data will, at least sometimes, need to be re-generated between Test Suite runs.

You may already have some process for generating random test opportunity data in your booking system (for example, copying data from a live environment snapshot, with personally identifiable information removed) and this may suffice for simple cases. However, the recommended approach is to create a script that populates your dataset with the exact required test opportunity data based on your implemented features. This ensures that you never waste debugging time on test runs that fail due to insufficient data. And it means that your testing solution will be sufficiently stable to run automatically in CI.

Test Data Generator

Use Test Data Generator to find out exactly how much test opportunity data needs to be in your booking system in order to run a given set of tests. The README in that project details how you can use this script to generate a test-opportunity-data.json file.

You can then create a custom script to populate your dataset using, as input, the test-opportunity-data.json file.

Example

This example should give you an idea as to how to write a custom script to populate your dataset. In this example, one of the .itemListElement items in your test-opportunity-data.json file looks like this:

{
  "@type": "ListItem",
  "item": {
    "@type": "Slot",
    "facilityUse": {
      "@type": "IndividualFacilityUse",
      "provider": {
        "@type": "Organization",
        "@id": "https://id.booking-system.example.com/organizer/3"
      }
    },
    "test:testOpportunityCriteria": "https://openactive.io/test-interface#TestOpportunityBookable",
    "test:testOpenBookingFlow": "https://openactive.io/test-interface#OpenBookingSimpleFlow",
  },
  "test:numberOfInstancesInDistribution": 32
}

When your script comes to process this item, it should consider the following:

• What type of opportunity to generate: for this item, Slots that belong to IndividualFacilityUses should be generated (note that the IndividualFacilityUses — and the FacilityUses that they belong to — can either be generated new or can already exist if they satisfy the other constraints).

• Seller: Which seller should the generated opportunities be created within. This will either be specified in .item.facilityUse.provider (for a Slot) or .item.superEvent.organizer (for a ScheduledSession). For this item, the Slots (and their parent IndividualFacilityUses and FacilityUses) should be created within the Seller with ID https://id.booking-system.example.com/organizer/3.

  • Test Data Generator will only use Sellers that you have already described in your Test Suite configuration.

• Booking Flow: Which booking flow the generated opportunities should support. Find this in item['test:testOpenBookingFlow']. For this item, the value is https://openactive.io/test-interface#OpenBookingSimpleFlow, which means that the generated opportunities need to support the Simple Booking Flow.

• Opportunity Criteria: The criteria constrains the properties of the generated opportunities. Find this in item['test:testOpportunityCriteria']. For this item, the value is https://openactive.io/test-interface#TestOpportunityBookable, whose description can be found in the Test Interface docs here.

• How many to generate: Find this in .['test:numberOfInstancesInDistribution']. For this item, the value is 32, so the script should generate (at least) 32 opportunities that fit these constraints.

It is strongly recommended to incorporate an element of diversity into your test opportunity data, to provide a greater testing surface area. For example, this could be done by using random data for some of your fields and randomly deciding whether to include certain fields e.g. image if images are optional in your dataset.