feat(test-data-generator): Output required Test Interface Actions #657

lukehesluke · 2024-03-14T11:13:21Z

Closes #656

Previously, test-data-generator generated one file, test-data/test-data.json, which listed the criteria of Opportunities that were required for testing.

Now, it generates two files:

output/opportunity-test-data.json: Same as the old one
output/test-interface-actions.json: Has TI Actions

I'll include some examples of the latter in the QA part.

The reason that I introduced TI Actions into a new file, rather than bringing them into the same file is because the original file has a very specific schema.org-style design. There's no where for TI Actions to be included – reasonable as it's really just a completely different style of data. So, instead there's a new file. It also uses the ItemList type, but each item, is just a TI Action type, with only @id, e.g. { "@type": "test:AccessChannelUpdateSimulateAction" }

QA

npm run test-data-generator (against default.json i.e. almost every feature):

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/test-interface"
  ],
  "@type": "ItemList",
  "numberOfItems": 12,
  "itemListElement": [
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:AccessChannelUpdateSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:AccessCodeUpdateSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:AccessPassUpdateSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:AttendeeAbsentSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:AttendeeAttendedSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:CustomerNoticeSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:ReplacementSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerAcceptOrderProposalSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerAmendOrderProposalSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerRejectOrderProposalSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerRequestedCancellationSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerRequestedCancellationWithMessageSimulateAction"
      }
    }
  ]
}

npm run test-data-generator -- common-error-conditions (a minimal example)

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/test-interface"
  ],
  "@type": "ItemList",
  "numberOfItems": 1,
  "itemListElement": [
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerAcceptOrderProposalSimulateAction"
      }
    }
  ]
}

Note: in theory, that one shouldn't have any actions in it at all. Accept Order Proposal action being in there is a kind of hack, explained in a code comment

npm run test-data-generator -- access-channel-update-notifications

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/test-interface"
  ],
  "@type": "ItemList",
  "numberOfItems": 2,
  "itemListElement": [
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:AccessChannelUpdateSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerAcceptOrderProposalSimulateAction"
      }
    }
  ]
}

NODE_ENV=dev npm run test-data-generator, where I changed dev.json to be: required features only, except for Seller Requested Cancellation (w & w/o message) and Seller Requested Replacement; simple flow only:

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/test-interface"
  ],
  "@type": "ItemList",
  "numberOfItems": 3,
  "itemListElement": [
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:ReplacementSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerRequestedCancellationSimulateAction"
      }
    },
    {
      "@type": "ListItem",
      "item": {
        "@type": "test:SellerRequestedCancellationWithMessageSimulateAction"
      }
    }
  ]
}

…-actions

lukehesluke · 2024-03-14T11:13:43Z

packages/openactive-integration-tests/test-data-generator/test-data/test-data.txt

I think this was just accidentally included in git

lukehesluke · 2024-03-14T11:14:04Z

packages/openactive-integration-tests/test/features/criteria-requirements.json

(auto-generated file) Changed to feature-requirements.json (which also now has TI actions)

lukehesluke · 2024-03-14T11:14:11Z

packages/openactive-integration-tests/test/features/feature-requirements.json

Auto-generated file

lukehesluke · 2024-03-14T11:36:41Z

packages/openactive-integration-tests/documentation/generator.js

@@ -15,7 +15,7 @@ const { FeatureJsonSchema } = require('./featureJson.js');

 const FEATURES_ROOT = path.join(__dirname, '..', 'test', 'features');
 const INDEX_README_FILE = path.join(FEATURES_ROOT, 'README.md');
-const INDEX_CRITERIA_REQUIREMENTS_JSON_FILE = path.join(FEATURES_ROOT, 'criteria-requirements.json');
+const INDEX_FEATURE_REQUIREMENTS_JSON_FILE = path.join(FEATURES_ROOT, 'feature-requirements.json');


Renamed because it now contains more info. But this new info (required TI Actions) is still per-feature. So, feature-requirements

If the reviewer is not aware, Test Data Generator gets its metadata from this file which is generated during automatic documentation generation (which has access to each test's describeFeature(..) metadata)

Appreciate the rename very much!

lukehesluke · 2024-03-14T11:40:55Z

packages/openactive-integration-tests/test-data-generator/README.md

@@ -13,10 +19,12 @@ npm run test-data-generator # all active features specified in the current confi

 npm run test-data-generator -- common-error-conditions # only enough data for the common-error-conditions feature

-npm run test-data-generator -- --output ./test-data.json # output to ./test-data.json
+npm run test-data-generator -- --output-dir ../../../test-data-generator-output # output to ../../../test-data-generator-output


--output-dir seems a bit simpler to maintain when we're now dealing with multiple output files and I expect sufficiently customizable for most purposes? Please correct me if I'm wrong!

Yep makes sense

lukehesluke · 2024-03-14T11:41:31Z

packages/openactive-integration-tests/test-data-generator/test-data-generator.js

+  ! There is a sort-of bug here, which is that
+  test:SellerAcceptOrderProposalSimulateAction will be outputted even if Test
+  Data Generator has been called on a category or feature that doesn't include
+  successful bookings. This is technically incorrect. In the opinion of this
+  author, it's fine because every Booking System should be able to support
+  successful bookings (!) */


…-actions

…erator-ti-actions

…enerator-ti-actions

lukehesluke added 15 commits March 12, 2024 14:29

Check if testInterfaceActions is as documented

76ce6ef

change everything. cry. repeat

71717f3

its in features/README.md. gd gd stf

17098aa

add a test prerequisites section for TI actions

75893b0

typed logs in logger.js

7e537d6

next step

e74c9f8

lint + TS improvements

07cc936

laying some groundwork..

52ccbca

it works!

e9d109c

better msgs

3b2d6c3

fill out comments

93f307b

minor fixes

81037e2

fix accept-proposal-book

c3a88c2

Merge remote-tracking branch 'origin/master' into feature/annotate-ti…

7dcfc7a

…-actions

works. Probably done

c8598a7

lukehesluke commented Mar 14, 2024

View reviewed changes

packages/openactive-integration-tests/test/features/feature-requirements.json Outdated

Copy link

Contributor Author

lukehesluke Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto-generated file

lukehesluke commented Mar 14, 2024

View reviewed changes

fixies

dc83f0c

lukehesluke marked this pull request as ready for review March 14, 2024 11:42

lukehesluke requested a review from civsiv March 14, 2024 11:46

lukehesluke added 3 commits March 18, 2024 10:07

arrays are sorted

eb4f4bc

Merge remote-tracking branch 'origin/master' into feature/annotate-ti…

e325796

…-actions

Merge branch 'feature/annotate-ti-actions' into feature/test-data-gen…

79bcf75

…erator-ti-actions

Base automatically changed from feature/annotate-ti-actions to master March 18, 2024 15:25

Merge remote-tracking branch 'origin/master' into feature/test-data-g…

81ecc5a

…enerator-ti-actions

civsiv approved these changes Mar 19, 2024

View reviewed changes

lukehesluke merged commit dd45abd into master Mar 19, 2024
32 checks passed

lukehesluke deleted the feature/test-data-generator-ti-actions branch March 19, 2024 11:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(test-data-generator): Output required Test Interface Actions #657

feat(test-data-generator): Output required Test Interface Actions #657

lukehesluke commented Mar 14, 2024 •

edited

Loading

lukehesluke Mar 14, 2024

lukehesluke Mar 14, 2024

lukehesluke Mar 14, 2024

lukehesluke Mar 14, 2024

lukehesluke Mar 14, 2024

civsiv Mar 15, 2024

lukehesluke Mar 14, 2024

civsiv Mar 15, 2024

lukehesluke Mar 14, 2024

feat(test-data-generator): Output required Test Interface Actions #657

feat(test-data-generator): Output required Test Interface Actions #657

Conversation

lukehesluke commented Mar 14, 2024 • edited Loading

QA

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukehesluke commented Mar 14, 2024 •

edited

Loading