test: Add bats test coverage for Drupal Core and Drupal CMS quickstarts #6893

rpkoller · 2025-01-13T11:49:48Z

This PR is adding tests for Drupal Core and Drupal CMS, updates the drupal quickstarts layout wise and makes a change to the common setup function.

Rendered quickstart: https://ddev--6893.org.readthedocs.build/en/6893/users/quickstart/#drupal

about the tests: i've added a fifth test that is currently commented out. it requires a creation of a test repo in the ddev org on github first (https://github.com/ddev/test-drupal.git would be the same naming pattern used for backdrop). the zip based test for drupal cms contains one additional line that renames the directory. problem is the zip file contains a folder called drupal-cms. due to the fact that launc-drupal-cms.sh contains a ddev config command that makes the project name drupal-cms in consequence and that way the teardown same sas the launch and validate the running project tests are unable to find the default project name my-drupal-site (PROJNAME in line 4)

about the quickstarts: i've added ddev startbefore ddev composer create. during the creation of the draft i've noticed that quickstarts are inconsistent some composer based are using ddev start some are not. it should be consistent and @rfay noted that it is always good to educate people with these quickstarts and show them what is actually happening even though for ddev composer create a ddev startwould be automatically executed. the other change i'Ve made is to add two h3s within the drupal h2 and move the two quickstarts for drupal cms into a seperate tabbed box within the drupal cms h3.

about the common-setup.sh: loaded the bats-file library as well that provides some additional asserts and more. based on the instructions from the other PR bats-file is available but was not loaded yet.

IMPORTANT: The PR has to be updated on the 15th of january updating the links related to Drupal CMS with the release of version 1.0.0

The Issue

#

How This PR Solves The Issue

Manual Testing Instructions

Automated Testing Overview

Release/Deployment Notes

…r quickstart

rpkoller · 2025-01-13T12:30:48Z

The Drupal CMS composer test is failing https://github.com/ddev/ddev/actions/runs/12746756015/job/35523444093?pr=6893 ... i thought maybe another commit got in minutes ago. but i've manually tested locally again and it still passes for me. so no idea why is going wrong when the tests run here on github?

and one other thought i wonder if it would make sense to add a third quickstart for drupal cms that is not using the installer but instead a drush site install and which provides the command line equivalent how to apply all the optional recipes via the command line. something i struggled and still have to look up each and every time.

docs/tests/drupal.bats

Co-authored-by: Randy Fay <randy@randyfay.com>

rfay · 2025-01-13T16:44:36Z

docs/content/users/quickstart.md

    ddev composer install # If a composer build
    ddev launch
    ```

+### Drupal CMS


Please add a link to the Drupal CMS pages on drupal.org that are relevant here, especially the tarball download page, etc.

then would drupal core also need necessary links? and there is a tar ball version of drupal cms? i am only aware of the zip file and the composer repo

would drupal core also need necessary links

It's a good idea to link to the page that the technique is built on, thanks!

and there is a tar ball version of drupal cms

I meant zipball of course

wouldnt the link to the zip be redundant, it is already listed in the quickstart itself? not that i wouldnt do it, i just mean to keep things concise?

I propose that in every quickstart we link to the basis of the quickstart. We do that in many of them. Drupal can do it as well. It's instructional. We want people to understand why the quickstart is what it is and then they can also perhaps see what's the difference between the upstream install/getting-started docs.

…ug of the launch statement

docs/content/users/quickstart.md

stasadev · 2025-01-13T16:48:44Z

docs/tests/drupal.bats

+  cd ${tmpdir}/${PROJNAME}
+  assert_success
+  # execute launch script
+  run DDEV_DEBUG=true ./launch-drupal-cms.sh


I tried this locally, worked for me:

Suggested change

run DDEV_DEBUG=true ./launch-drupal-cms.sh

run env DDEV_DEBUG=true ./launch-drupal-cms.sh

i'Ve already pushed a change to run bash -c "DDEV_DEBUG=true ddev launch"the same pattern that is used for the ddev launch asserts. if that fails i can go with the env variant.

@stasadev the tests are green with the run bash -c "DDEV_DEBUG=true ddev launch"change. should i keep it that way or change to the env approach?

Let's keep it the same as in other places.

@stasadev

per recommendation by @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

@stasadev

per recommendation of @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

rfay

I don't think the text

The legacy type drupal will be interpreted as the latest stable version of Drupal, so in 2024, ddev config --project-type=drupal will configure a Drupal 11 project. drupal can also be used as the project type in the .ddev/config.yaml but it will be interpreted as the latest stable version.

is that useful any more, but open to ideas. Certainly it should say 2025. But it seems out of place here.

Currently "Drupal CMS" is not showing up as a tab on "Drupal" as it should:

Please make "Drupal CMS" part of Drupal. The two options (Composer and Zip) can be shown there inline, or the composer approach can be done in a gist, or whatever.

rfay

Thanks for the great work and significant contribution here! This is a great step forward.

rfay · 2025-01-13T17:32:06Z

docs/tests/drupal.bats

+  assert_output --partial "HTTP/2 200"
+}
+# Test for the git based quickstart. Has to be uncommented
+# as soon as the Drupal test repo is created on GitHub


I don't understand about waiting for Drupal test repo, it's been there for some time. https://github.com/ddev/test-drupal11 - if you need some improvement in this, you can have privileges on it or you can request a change.

BTW, rather than commenting it out, use skip to skip something that's not ready for prime time. That makes it much easier to fix when it's ready.

lol i didnt knew that there is already a testrepo in place! then i would have skipped it. it sounded like that repo would have to be created first. thats why i commented it out. and also didnt knew about the skip command. ;) currently testing the uncommented test and will then push another commit

docs/tests/drupal.bats

rfay · 2025-01-13T17:35:03Z

docs/tests/drupal.bats

+}
+
+@test "Drupal CMS zip file quickstart with $(ddev --version)" {
+  # curl -o my-drupal-site.zip -fL https://ftp.drupal.org/files/projects/cms-1.0.0-rc2.zip


Same comment, use same exact thing in test as in quickstart.

that was me being lazy. but will do

rpkoller · 2025-01-13T19:08:31Z

I don't think the text

The legacy type drupal will be interpreted as the latest stable version of Drupal, so in 2024, ddev config --project-type=drupal will configure a Drupal 11 project. drupal can also be used as the project type in the .ddev/config.yaml but it will be interpreted as the latest stable version.

is that useful any more, but open to ideas. Certainly it should say 2025. But it seems out of place here.

I consider the detail about the project type drupalbeing an alias for the latest stable major version of that project type an important detail to note. How about:

The project type `drupal` is an alias for the latest stable version of Drupal, which currently is version 11.

maybe place it even in such an fyi box?

rpkoller · 2025-01-13T19:15:08Z

Currently "Drupal CMS" is not showing up as a tab on "Drupal" as it should:

that was intentional.a single tab with just drupal CMS and having two different approach under one roof felt off. adding a second tab felt also off and the tab got more crowded. strictly speaking the idea is that drupal cms is something "new" and its own "product" so i thought having two boxes felt more clear and cleaned up. but i can change it back later.

rfay · 2025-01-13T19:33:54Z

Thanks, please do keep "Drupal CMS" under Drupal.

For the drupal project type... It's not even mentioned or used anywhere in these quickstarts, so I don't think it belongs here. If there are other places we can improve its use in the docs, it's great to mention it there.

…tency, working github based test

rpkoller · 2025-01-13T21:16:51Z

ok the PR would be ready for another round of review. pushed all changes. all tests are uncommented and working now, applied the feedback, and tried to be consistent. hope i've catched everything

docs/content/users/quickstart.md

@stasadev

the to be unzipped archive for drupal cms still had the name drupal-cms... by @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

rfay · 2025-01-14T16:54:50Z

Let's wait until tomorrow and remove the Drupal CMS tag before pulling.

rpkoller · 2025-01-14T17:19:33Z

Let's wait until tomorrow and remove the Drupal CMS tag before pulling.

which tag you refer to? and tomorrow the tests and quickstarts for drupal cms could be updated with the release of 1.0.0

rfay · 2025-01-14T17:21:50Z

Tomorrow CMS_VERSION=1.0.0-rc2 will be something else (maybe they'll remove that?)

And in ddev composer create --stability="RC" drupal/cms we won't need --stability any more at all

rpkoller · 2025-01-14T17:27:16Z

ahhh that you meant, yep i completely agree then. just wanted to make there wasnt another detail you were referring to and i was missing.

nlighteneddesign · 2025-01-15T18:34:05Z

These look good to me!

docs/tests/drupal.bats

stasadev · 2025-01-15T20:34:48Z

docs/content/users/quickstart.md

+    PROJECT_GIT_URL=https://github.com/ddev/test-drupal11.git
+    git clone ${PROJECT_GIT_URL} my-drupal-site


I wanted to ask if we use the repositories from ddev org for Git Clone?

I'm asking because typo3 PR #6895 didn't have this change in the quickstart docs.

uhhhhhhh why the typo3 quickstart isnt using test-typo.git,i thought i've changed that?! then the typo3 quickstart needs that small update as well. how could i have missed that? i am puzzled. thank you for noticing!

i will quickly open another PR fixing that.

for reference, opened #6904

IMO it's not fundamentally important to use .git. I never do when cloning a repo.

didn't know that, but i just tried to be explicit and follow what is provided in the core button. that is what i always followed.

@stasadev

by @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

stasadev · 2025-01-15T21:42:13Z

The Drupal CMS zip file quickstart test fails because of incorrect condition in launch-drupal-cms.sh

if [ $n > 0 ]; then
  NAME=$NAME-$(expr $n + 1)
fi

It should be

if [ $n -gt 0 ]; then
  NAME=$NAME-$(expr $n + 1)
fi

rfay · 2025-01-15T21:44:07Z

Now that Drupal CMS has a web page for installation, please add a link to it at the top, thanks! Ready to go otherwise!

tyler36 · 2025-01-16T00:45:22Z

Confirming the "Drupal CMS" guide, nice update!

rfay · 2025-01-16T01:23:10Z

The square brackets are ugly. Could you make it Read more about Drupal Core and Installing Drupal Core - like that? with links?

rpkoller added 4 commits January 13, 2025 12:31

Load bats-file in common-setup.bash

ee60636

move two drupal cms quickstarts into separate box within drupal section

548af64

initial draft for testing quickstarts for drupal

ce7b521

add ddev start to the quickstarts where it is missing

0bd425c

rpkoller requested a review from a team as a code owner January 13, 2025 11:49

github-actions bot added maintenance labels Jan 13, 2025

rpkoller added 2 commits January 13, 2025 12:54

change the directory name to my-drupal-site on the drupal cms compose…

409c351

…r quickstart

remove empty line to mind linter recommendation

7529b43

rfay reviewed Jan 13, 2025

View reviewed changes

docs/tests/drupal.bats Outdated Show resolved Hide resolved

add ddev_debug for the launch-drupal-cms.sh script execution

709c8c5

Co-authored-by: Randy Fay <randy@randyfay.com>

rfay reviewed Jan 13, 2025

View reviewed changes

wrap ddev_debug launch script in run bash statement like the ddev_deb…

e81d926

…ug of the launch statement

stasadev requested changes Jan 13, 2025

View reviewed changes

rpkoller and others added 2 commits January 13, 2025 17:55

Fix the case for the tab label Zip File

d10ab89

per recommendation by @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

Make Core in Drupal Core upper case

6457d47

per recommendation of @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

stasadev approved these changes Jan 13, 2025

View reviewed changes

rfay reviewed Jan 13, 2025

View reviewed changes

rfay requested changes Jan 13, 2025

View reviewed changes

rpkoller added 4 commits January 13, 2025 21:41

includes feedback, add missing ddev start statements, improved consis…

29f956c

…tency, working github based test

fix the url for the drupal cms curl zip download

1e159f6

and uncomment other tests again, was too overeager pushing

9d2ea03

adjust the corresponding quickstart to the change

07c4a21

stasadev requested changes Jan 14, 2025

View reviewed changes

docs/content/users/quickstart.md Outdated Show resolved Hide resolved

fixing consistency detail between tests and quickstart

1907fb0

the to be unzipped archive for drupal cms still had the name drupal-cms... by @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

stasadev approved these changes Jan 14, 2025

View reviewed changes

update quickstarts and ZIP dl link to stable 1.0.0

1034dc8

stasadev reviewed Jan 15, 2025

View reviewed changes

stasadev mentioned this pull request Jan 15, 2025

docs: Update quickstart.md for Drupal CMS, remove --stability="RC" #6903

Closed

add a missing whitespace for alignment

37f1ae2

by @stasadev Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>

skip the zip based bats test until a fix is in

616c17f

add links to marketing site and docs for core and cms

16489f8

rpkoller added 2 commits January 16, 2025 02:31

fix the the styling and syntax of the previously added links

7a91123

forgot to update the link style and syntax on one tab

9690a2e

rfay merged commit 4e8a797 into ddev:main Jan 16, 2025
7 of 11 checks passed

rpkoller deleted the 20250111-rpkoller-drupal-tests branch January 16, 2025 04:30

	run DDEV_DEBUG=true ./launch-drupal-cms.sh
	run env DDEV_DEBUG=true ./launch-drupal-cms.sh

		PROJECT_GIT_URL=https://github.com/ddev/test-drupal11.git
		git clone ${PROJECT_GIT_URL} my-drupal-site

test: Add bats test coverage for Drupal Core and Drupal CMS quickstarts #6893

test: Add bats test coverage for Drupal Core and Drupal CMS quickstarts #6893

Conversation

rpkoller commented Jan 13, 2025 • edited by rfay Loading

The Issue

How This PR Solves The Issue

Manual Testing Instructions

Automated Testing Overview

Release/Deployment Notes

rpkoller commented Jan 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rfay left a comment

Choose a reason for hiding this comment

rfay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rpkoller commented Jan 13, 2025 • edited Loading

rpkoller commented Jan 13, 2025

rfay commented Jan 13, 2025

rpkoller commented Jan 13, 2025

rfay commented Jan 14, 2025

rpkoller commented Jan 14, 2025

rfay commented Jan 14, 2025

rpkoller commented Jan 14, 2025

nlighteneddesign commented Jan 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stasadev commented Jan 15, 2025 • edited Loading

rfay commented Jan 15, 2025

tyler36 commented Jan 16, 2025

rfay commented Jan 16, 2025

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

rpkoller commented Jan 13, 2025 •

edited by rfay

Loading

rpkoller commented Jan 13, 2025 •

edited

Loading

stasadev commented Jan 15, 2025 •

edited

Loading