TODO

• Finish the test phpunit.
• Send email with report. Add it to the settings options.
• Confirm that everyone of the unittests works ok, and explain how to make a new unittest with a specific page.
• cleanup the code for the output for the backend. Now it has obsole and not used code. Clean all commented code.
• translations
• add new categorization of results, add a class to the result in the frontend, and a button to show those particular kind of results or not.
  • event where the date in cartelera is not completed
  • event where all dates from ticketmaster are in cartelera, but there are more in cartelera which are later than the last one in ticketmaster, and add a button to consider these ones a a valid results.
  • think about other kind of results...

WHAT IS THIS PROJECT

• This is a plugin of WordPress. It's purely managed from a custom settings page (no frontend).
• It's developed in wp- env.
• This projects will scrap the list of theater shows in https://carteleradeteatro.mx/,
• and compare it with the same shows in http://ticketmaster.com.mx/.
• It will ensure that all timetables are the same.
• In case it finds an error, it will display it, or send an email

Note: The e2e PHPUnit test is very useful to see the entire sequence of what the plugin does.

HOW IT WORKS

First it scan and scrap the carteleradeteatro.mx/todas to grab all the titles for all theathre shows.

In the table options, it saves that list as the queue of shows that need to be scraped On every iteration, it scrap one by one every show in the list, starting by the first.

Once processed, it saves the result in the table options too, and removes the processed show from the queue.

When this whole process is finished, we have the relevant data for all shows, either from carteleradeteatro and from ticketmaster. It looks like this.

• The results of scrapping both sites can be exported and saved in a file called wp-content/uploads/cartelera-scrap/cartelera-scrap-results.json. There is a button in the settings page for that.

NOTE: most of shows are only in cartelera, but has no entry in ticketmaster.

Settings:

[...]

DEVELOPMENT

Dependencies

• v18.20.3
• npm 10.7.0
• composer 2.7.9
• install wp-env globally (when I run it locally it takes too long to load).

npm run up this will also install a folder /wordpress for better development.

or, the first time use the global package of wp-env if it doesnt work npm run upglobal WordPress development site started at http://localhost:8666 WordPress test site started at http://localhost:8667 MySQL is listening on port 54868 MySQL for automated testing is listening on port 54878

Use docker ps | grep mysql to know the port at anytime.

Use CLI

wp-env run cli wp-env run cli bash

Use CLI for DB connection (MySQL/MariaDB)

The raw connection would be (replacing the port with the one created by wp-env):

mysql -h127.0.0.1 -P54868 -uroot -p

Using DB CLI wp-env run cli wp db cli

To know more info, which can be used to connect from a DB Client.

wp-env run cli wp config get DB_HOST   # Host is 127.0.0.1
wp-env run cli wp config get DB_NAME   # Name is wordpress
wp-env run cli wp config get DB_USER   # User is root
wp-env run cli wp config get DB_PASSWORD   # Password is password
And the port you'll have to find out with
> `docker ps | grep mysql`

Simple way to export and import DB into the root of the project wordpress.sql:

sh ./bin/export-db.sh

sh ./bin/import-db.sh

Use WP CLI

wp-env run cli wp get option siteurl

PHPCS

Installed Alleys PHPCS standards, which uses WordPress VIP. Installed PHPStan too. Both work ok, check composer.json scripts to run the phpcs, phpcbf and phpstan commands. Check AI-AGENT.md for more info.

commands

composer run lint,
composer run format,
composer analyze
npm run cs .
npm run cbf .

PHPUNIT

npm run test:php
npm run test:php:watch

it uses wp-env run tests-wordpress ...

Following the last PHPUnit installation working version: https://github.com/cobianzo/wp-env-sidebar-related-article/ PHPUnit 9.4.

Important, we need to use php 8.3 in wp-env, so we can run the package wp-env run tests-wordpress which works perfectly out of the box.

The watch version of the phpunit run works like charm!!

If run teh tests outside the container, it's still not tested.

packages:

• phpunit/phpunit: ! important, version 9 max, or it will be incompatible with function inside teh tests. Then we can access locally o inside the container to wp-content/plugins/cartelera-scrap/vendor/bin/phpunit
• yoast/phpunit-polyfills it must be installed, and wp-env run tests-wordpress finds it automatically. When installed, it install phpunit, as it depends on it, but the version 12. We need to install phpunit ourselves, the version 9, so there are no incompatibilites.
• spatie/phpunit-watcher: for the phpUnit watcher, ran with npm run test:php:watch.
• wp-phpunit/wp-phpunit: not needed, all the bootstrap is handled by wp-env run tests-wordpress

TESTS PHP

Since we use cron jobs, and we can't run then naturally in local, I created a couple of scripts to run it.

There are two cron jobs in this project:

• 'cartelera-scrap_automated_cron' : runs every day at midnight, if activated in the settings page
• 'cartelera-scrap_process_next_onetimeoff' : recursive one-time-off cron that calls itself until the option 'cartelera-scrap_shows_queue' is emptied

Use

• npm run test:listcron - to show all cron jobs scheduled
• npm run test:runcron - to run the next recursive one time off cron job
• npm run test:options - to see the settings about this plugin saved in the DB.

Useful WP CLI commands

// === USEFUL ACTIONS

// check the queue wp-env run cli wp option get cartelera-scrap_shows_queue

// results wp-env run cli wp option get cartelera-scrap_shows_results

// check option wp-env run cli wp option get test-updated

// check cron jobs scheduled wp-env run cli wp cron event list

// delete the cron job wp-env run cli wp cron event delete cartelera_process_next_show

// run of the cron job wp-env run cli wp cron event run cartelera_process_next_show

// show all options names from this plugin (also with npm run db:options) npm run wpcli db query \"SELECT option_name FROM wp_options WHERE option_name LIKE '%cartelera_%';\"