Test Interface Actions

The Test Interface Actions endpoint is called by Test Suite to simulate different actions in your booking system e.g. "Seller-requested cancellation".

Your booking system only need to implement those actions which relate to features that it implements.

Descriptions for each action can be found in the Test Interface doc.

Which Actions to implement?

Use Test Data Generator to find out which Test Interface actions your booking system needs to implement. Follow these steps:

  1. In your Test Suite instance, which you configured in the previous step, run:

# Use your config/dev.json config file
export NODE_ENV=dev
# Run Test Data Generator
npm run test-data-generator
  1. The logs from this script will point to two files that it generated, called:

    • opportunity-test-data.json

    • test-interface-actions.json

  2. The test-interface-actions.json file will contain a list of Test Interface actions that you need to implement for the features that your booking system supports. To see an example of what this looks like, see the Test Data Generator README.

Test Interface Action Implementation Guidelines

1. Switch Statement

Use something like a switch statement for your actions endpoint. For example, if your booking system only needs to support the test:SellerRequestedCancellationSimulateAction and test:CustomerNoticeSimulateAction actions, your route would look like (using Node.js with Express as an example):

app.post('/test-interface/actions', (req, res) => {
  const actionType = req.body['@type'];
  switch (actionType) {
    case 'test:SellerRequestedCancellationSimulateAction':
      simulateSellerRequestedCancellation(req, res);
    case 'test:CustomerNoticeSimulateAction':
      simulateCustomerNotice(req, res);

2. Test Interface Actions must use same code pathways as real-life counterparts

As an example, when implementing the test:SellerRequestedCancellationSimulateAction Test Interface action, the test logic should use, as much as possible, the same code pathways as are called when an administrator cancels an activity in the real system. The goal is to replicate real-world processes accurately, rather than simply employing quick fixes to meet Test Suite expectations.

Here is a very simplified example of the correct way to do this (using Node.js with Express):

app.get('/internal-admin-api/dashboard', (req, res) => {
  res.send(`<form action="cancel-order" method="POST">
    <label for="orderId">Cancel Order with ID:</label>
    <input type="text" id="orderId" name="orderId" required />
    <input type="submit" value="Cancel" />

app.post('/internal-admin-api/cancel-order', async (req, res) => {
  await cancelOrderAndUpdateOrdersFeeds(req.body.orderId);
  res.send('Successfully cancelled!');

app.post('/test-interface/actions', (req, res) => {
  const actionType = req.body['@type'];
  switch (actionType) {
    case 'test:SellerRequestedCancellationSimulateAction':
      await cancelOrderAndUpdateOrdersFeeds(req.body.object['@id']);
    // ... other actions

async function cancelOrderAndUpdateOrdersFeeds(orderId) {
  // ...

This approach is key to ensuring that Test Suite accurately verifies all of the booking system's behaviours that will occur in real-life operation.

Last updated