End to end testing

[patrickrb]

This pull request was branched from the #3038 branch, but could be merged independently if we close the other one.

You can see the tests running against this PR here: https://github.com/magicbug/Cloudlog/actions/runs/8591149336/job/23539563254

This pull request introduces significant changes to the project, primarily focusing on the introduction of Docker and Cypress for containerization and end-to-end testing respectively. The changes facilitate the setup of a local development environment using Docker and Docker Compose, and the implementation of Cypress for automated testing. Additionally, there are updates to the .env.sample file and a new GitHub workflow for Cypress tests.

Docker and Docker Compose setup:

• .env.sample: Added new environment variables for MySQL configuration, base locator, website URL, and directory.
• Dockerfile: Introduced a Dockerfile for PHP and Apache with necessary system dependencies.
• Dockerfile-db: Created a Dockerfile for MariaDB.
• docker-compose.yml: Added a Docker Compose file to manage the services for the web application and database.
• script.sh: Added a shell script to replace placeholders in the configuration files with environment variables and start Apache in the foreground. This eliminates the need for the install page which was necessary for automated testing.

Cypress and GitHub Workflow:

• .github/workflows/cypress-tests.yml: Introduced a new GitHub workflow for running Cypress tests.
• cypress.config.js: Added a Cypress configuration file.
• cypress/e2e/1-login.cy.js, cypress/e2e/2-version-info.cy.js: Implemented Cypress tests for login and version info modal. [1] [2]
• cypress/support/commands.js, cypress/support/e2e.js: Added Cypress support files for custom commands and e2e tests. [1] [2]
• package.json: Added Cypress as a devDependency.

Other changes:

• README.md: Updated the README to include instructions for setting up a Docker development environment.
• application/controllers/User_options.php: Added a new function to enable the version dialog.
• install/index.php: Updated the installation form to pre-fill database configuration fields with environment variables.

Cypress tests running locally:

Login tests

Version info tests

Cypress tests running in github actions:

Login tests:

Version info tests

Summary:

[magicbug]

Bit early for me to comment as I've just not had time to try it, that being said some testing is very much needed.

Hopefully have some time during this week

[magicbug]

Hi @patrickrb

Sorry for delay but finally got time to look into it all

When I do composer up I'm getting the following error

cloudlog-web-1  | /usr/local/bin/docker-php-entrypoint: 9: exec: ./script.sh: not found
cloudlog-web-1 exited with code 127

[magicbug]

Got past that error using https://stackoverflow.com/questions/44460825/entrypoint-file-not-found

However getting

A PHP Error was encountered
Severity: Warning

Message: mysqli::real_connect(): php_network_getaddresses: getaddrinfo failed: Name or service not known

Filename: mysqli/mysqli_driver.php

Line Number: 203

[magicbug]

Ok got passed that with adding mynet see commit.

What I have noticed is that when creating the config.php

$config['base_url']	= 'http://localhost
';

It seems to add a new line which of course is a breaking item

[magicbug]

Cypress works fantastic and overall very happy with this PR.. @patrickrb not sure what you think about the base_url or if just ignore it could be just windows CRLF issues

[patrickrb]

Cypress works fantastic and overall very happy with this PR.. @patrickrb not sure what you think about the base_url or if just ignore it could be just windows CRLF issues

Awesome, glad you were able to get it working! Excited to see this implemented further.

Going to be at a conference this weekend, should have some time to look at it on Sunday, thanks for trying it out and adding some fixes!

[magicbug]

Going to be at a conference this weekend, should have some time to look at it on Sunday, thanks for trying it out and adding some fixes!

Have fun at the conference!

[magicbug]

@patrickrb did you have any ideas on the new line issue in config.php or think like me it was windows related and nothing to worry about

[patrickrb]

@patrickrb did you have any ideas on the new line issue in config.php or think like me it was windows related and nothing to worry about

Going to take a look at it today!

[patrickrb]

@patrickrb did you have any ideas on the new line issue in config.php or think like me it was windows related and nothing to worry about

Going to take a look at it today!

havent been able to replicate it so far, still looking

[magicbug]

I think it was a windows one off issue, shall merge it in and see how it acts :)

[patrickrb]

I think it was a windows one off issue, shall merge it in and see how it acts :)

Awesome, i'll start writing some more tests for some of the main stuff like submitting QSO's. Ideally we'll write tests around areas where bugs are reported, no sense in having tests for code that doesnt break.