[6.0] Add Support for Github Codespaces

[mahmoudmagdy1-1]

Continuation of #45552

Summary of Changes

a fully Joomla stack : fresh joomla installation with phpmyadmin,xdebug,cypress
This PR adds the ability to test other PRs using GitHub Codespaces, or even use it as a full development environment.
you can access the database directly using phpmyadmin, and run tests using Cypress, you can find more details in the codespace-details.txt file after creating the codespace with this PR

Testing Instructions

1. Create a new codespace from a branch that contains the .devcontainer files
2. You can access and see the Joomla install / Cypress GUI in "ports" inside github.dev
3. For credentials and more details you can see codespace-details.txt

Actual result BEFORE applying this Pull Request

N/A

Expected result AFTER applying this Pull Request

An easy way to test PRs on the cloud without setting everything up manually and on your local machine

Link to documentations

Please select:

• Documentation link for docs.joomla.org:

• No documentation changes for docs.joomla.org needed

• Pull Request link for manual.joomla.org: Add Docs for Github Codespaces Manual#496

• No documentation changes for manual.joomla.org needed

[brianteeman]

Is it expected that at the end of the setup the terminal doesnt return to a prompt

[brianteeman]

It is not possible to run the cypress tests as Joomla wont install in this configuration see screenshot

[mahmoudmagdy1-1]

It is not possible to run the cypress tests as Joomla wont install in this configuration see screenshot

we don't need to run the installation script as Joomla is already installed automatically, you can access it when clicking on this after the github codespaces finishes building

other tests pass normally using this setup, for example:

[mahmoudmagdy1-1]

Is it expected that at the end of the setup the terminal doesnt return to a prompt

yes this is expected after building the container, but you can always start a new terminal

[brianteeman]

Is it expected that at the end of the setup the terminal doesnt return to a prompt

yes this is expected after building the container, but you can always start a new terminal

thanks - was just checking

[brianteeman]

It is not possible to run the cypress tests as Joomla wont install in this configuration see screenshot

we don't need to run the installation script as Joomla is already installed automatically, you can access it when clicking on this after the github codespaces finishes building

Then I suggest a change in the text is required because it currently says

    echo "  Run interactive tests: npx cypress open"
    echo "  Run headless tests:   npx cypress run"

and that fails because the first test is installation and that will fail for the reasons above

[mahmoudmagdy1-1]

Then I suggest a change in the text is required because it currently says

    echo "  Run interactive tests: npx cypress open"
    echo "  Run headless tests:   npx cypress run"

and that fails because the first test is installation and that will fail for the reasons above

okay, what do you suggest i should change the text to? i want to also add that you can use npx cypress run --spec path/to/file.spec.js to run a specific spec and you don't have to run all specs at once
I think the current cypress tests are mainly focused on the ci pipeline (please correct me if i'm wrong), but at least with this setup if someone wants to test or add a spec they can

[mahmoudmagdy1-1]

I just edited some of the joomla config names to match Cypress config' default values, and got Cypress to run and pass all tests, except 2 test files that had 2 errors each

those are the files with the errors

the error is the same for all 4 failing tests:

I would love to hear some feedback about the setup and if someone can direct me on how fix the last errors, this exact error was mentioned in #44434 but had no actual solution

[alikon]

even it is a temporay fix , as it is already done in other plcaes, you can do the same where tests are failing

joomla-cms/tests/System/integration/site/components/com_contact/Router.cy.js

Lines 8 to 11 in 704aefc

	// @TODO: The following line is just a temporary fix. Remove it and uncomment the 2 lines after it when done.
	expect(response.status).to.eq(200);
	// expect(response.status).to.eq(301);
	// expect(response.redirectedToUrl).to.match(new RegExp(`${url}$`));

[laoneo]

This is great work, thanks. But we need also proper documentation so it will get attention and can be used for testing pr's.

[mahmoudmagdy1-1]

even it is a temporay fix , as it is already done in other plcaes, you can do the same where tests are failing

Okay sure

This is great work, thanks. But we need also proper documentation so it will get attention and can be used for testing pr's.

Thank you, Are we talking about documentation for the Joomla manual or where exactly? I'm willing to write a documentation for this feature

[softforge]

Hi @mahmoudmagdy1-1 would really like to get this in 6.0 but you only have days before the beta, can you write the documentation and just check through the comments and @Bodge-IT and I will try and get some tests
Thank you.

[brianteeman]

this pr doesnt include any production code so shouldnt be tied to the release of j6

[alikon]

imho should be backported to 5.3 / 5.4 as can help with the upcoming PBF

[alikon]

for 6.0 \define('JOOMLA_MINIMUM_PHP', '8.3.0');

[mahmoudmagdy1-1]

would really like to get this in 6.0 but you only have days before the beta

Hey @softforge, Like brian mentioned, it's not tied to the release of j6, it should work on all versions (5.3-dev, 5.4-dev) as well

can you write the documentation and just check through the comments and @Bodge-IT and I will try and get some tests Thank you.

Sure, I'm working on it right now, I think the best place for it, is : https://manual.joomla.org/docs/testing/manually

Thanks for the pr @alikon

[softforge]

Hey @softforge, Like Brian mentioned, it's not tied to the release of j6, it should work on all versions (5.3-dev, 5.4-dev) as well

Thank you for your work to date. I had just posted it back into maintainers to ask for the process and open the discussion there. I'll let you know as soon as I have an answer.

[mahmoudmagdy1-1]

Thank you for your work to date. I had just posted it back into maintainers to ask for the process and open the discussion there. I'll let you know as soon as I have an answer.

Thanks, I've also just added the documentation for this feature and put the link of the docs in the pr description

[alikon]

I have tested this item ✅ successfully on 371e787

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45719.}

[alikon]

it would be good to have this pr merged for the upcoming PBF

[rdeutz]

I have tested this item ✅ successfully on 7753b0d

Looks ok so far, tested login into Joomla and phpmyadmin. Let run the system tests. Control window doesn't fit 100%.
Setup takes some time but compared to setting it up locally much faster. Execution of the system tests fast enough.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45719.}

[laoneo]

Thank you very much for all the work on this and the patience. Now it is time to spread the word.