ODI publishing testing pipeline

chachasikes commented 3 years ago

Create a generic sandbox pipeline to test odi-publishing.

[ ] Priority 1: When editor pushes "Publish" (editor url) content writes __correct_content to correct github repo/branch and it updates on correct s3 bucket [future: then sends correct response to correct notification/response service.] - Type: Trigger event.

Reference: test priorities:

TBD:

zakiya commented 3 years ago

Relevant tasks:

Relevant PRs:

Future work:

chachasikes commented 2 years ago

Highlights from our discussions on testing this week:

We acknowledge that it's unlikely we will get 100% reliability coverage for our pipeline system since it uses multiple external services and some simulation proxies. However, we can use the 80|20 rule to try to test 80% of our changes in a development pipeline and the rest on production services with some clever use of testing tools.
Testing & TDD (test-driven development) can help avoid code fragility. Especially unit tests.
Working without tests means that the business logic and features of the service are lost in code logic.
Some strategically placed unit tests and input/output typing can make the code less fragile & easier to swap in new services.
Look up Azure FaaS resources for recommendations on testing FaaS outputs. Do same for AWS Lambda to compare.
Designing a serivce with a couple of systems in mind can help with code structure and scaling.
Go over the code base adding comments describe what something is intending to do and why.
The code type doc blocks are great.
The service has an additional layer of complexity: deployment.
Risk areas: external services, code regression/errors, third party plugins, system configuration.
We need to pull out all the endpoints so API developers can understand which kinds of data need to be mapped for polling and other site assets, and how to extend the data retreival. (e.g. pages, posts, media, other content types, redirects, lists of changes, and several others (there are a bunch))

chachasikes commented 2 years ago

Works locally - another step for another person to run it.

chachasikes commented 2 years ago

This week - make the development pipeline.

Then use the tester.

chachasikes commented 2 years ago

This might be a duplicate

chachasikes commented 2 years ago

Updated all the pantheon instances & made mirrors repos. Linked on Github board for Editor / CMS

zakiya commented 2 years ago

@chachasikes Which pantheon instances were updated?

chachasikes commented 2 years ago

Closing this one. If we regroup on this it will need to be part of a managed sprint.

cagov / odi-engineering