How do I test a report project PR?

[seanh]

I'm trying to test a PR for the report project, but it relies on information in LMS and H and I'm not sure how to run it?

[seanh]

Answer by @jon-betts from June 2023, imported from Stack Overflow for Teams:

How the data flows

The first thing to understand is how the data flows from one product to another. You will need to run the jobs in the same order. At the moment that order is:

• h - Depends on nothing
• LMS - Depends on h
• Report - Depends on LMS and h

The two types of job

Our reporting tasks tend to fall into two categories:

• report/create_from_scratch - A job which redefines views and queries
• report/refresh - A job which updates the data using the defined views and queries

Putting it all together

A full test therefore requires running both jobs in both configurations from start to finish through the products. If a particular product hasn't changed or you are testing products earlier in the chain, you can skip the relevant parts.

In order to have some data to report on, you will need to start all services relevant to LMS and play around to create some relevant activity to the test you are running.

Here is an example script you can follow:

cd h
make services
make devdata
tox -e dev --run-command "python bin/run_data_task.py -c conf/development-app.ini -t report/create_from_scratch"
tox -e dev --run-command "python bin/run_data_task.py -c conf/development-app.ini -t report/refresh"

cd ../lms
make services
make devdata
tox -e dev --run-command "python bin/run_data_task.py -c conf/development.ini -t report/create_from_scratch"
tox -e dev --run-command "python bin/run_data_task.py -c conf/development.ini -t report/refresh"

cd ../report
make services
make devdata
tox -e dev --run-command "python bin/run_data_task.py -t report/create_from_scratch --no-python"
tox -e dev --run-command "python bin/run_data_task.py -t report/refresh --no-python"

You can then use make shell to inspect the DB and ensure any new structures are there as you would expect.

Testing Report integration with Hubspot

When you run the report tasks it communicates with Hubspot unless you specify --no-python as above. We do this by default because it's much faster. If you are testing Hubspot related reports you will need to remove this from the command.

When we upload data to Hubspot it starts an async import process. You can monitor that here:

• https://app.hubspot.com/import/21081992 - For QA
• https://app.hubspot.com/import/6291320 - For Prod