From ff4441689113e613c7a15be196d46897f70feea6 Mon Sep 17 00:00:00 2001 From: Tom J Nowell Date: Sun, 12 Apr 2020 20:37:03 +0100 Subject: [PATCH 1/3] Create testing.md --- docs/en-US/troubleshooting/testing.md | 49 +++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/en-US/troubleshooting/testing.md diff --git a/docs/en-US/troubleshooting/testing.md b/docs/en-US/troubleshooting/testing.md new file mode 100644 index 0000000..97acf45 --- /dev/null +++ b/docs/en-US/troubleshooting/testing.md @@ -0,0 +1,49 @@ +--- +category: 5. Troubleshooting +order: 3 +title: Testing +description: How To Test VVV +permalink: /docs/en-US/troubleshooting/testing/ +--- + +## Main VVV Repo + +To test changes to the main repo, we need to check that it doesn't break an existing VM, and that it doesn't stop new VVV installs from working. + +### Checking An Existing VM + +Take an existing VVV install, and switch to the branch that has the changes, then reprovision. GitHub will have CLI instructions for how to checkout the branch with the new changes near the merge button. + +Once the folder has the changes, run `vagrant halt && vagrant up --provision`. + +## Utilities + +You can test a new utility by adding it to `config/config.yml` and reprovisioning. + +To test changes to the core provisioner, delete the `provision/utilities/core` folder, then change the `config/config.yml` file to match the repo and branch you'd like to test: + +```yaml +utility-sources: + core: + repo: URL of repo to test + branch: name of branch to test +``` + +Then, halt the VM and reprovision: `vagrant halt && vagrant up --provision` + +## Dashboard + +```yaml +``` + +## Custom Site Template + +```yaml +``` + +If the pull request adds new parameters, check that they work as expected, and check that things still work if the parameter is missing/blank. + +## Custom Site Template Develop + +```yaml +``` From 068106fec066ddd608752050901b53dae593c368 Mon Sep 17 00:00:00 2001 From: Daniele Scasciafratte Date: Wed, 2 Sep 2020 14:51:33 +0200 Subject: [PATCH 2/3] added example for custom site templates --- docs/en-US/troubleshooting/testing.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/en-US/troubleshooting/testing.md b/docs/en-US/troubleshooting/testing.md index 97acf45..ecd0400 100644 --- a/docs/en-US/troubleshooting/testing.md +++ b/docs/en-US/troubleshooting/testing.md @@ -18,7 +18,7 @@ Once the folder has the changes, run `vagrant halt && vagrant up --provision`. ## Utilities -You can test a new utility by adding it to `config/config.yml` and reprovisioning. +You can test a new utility by adding it to `config/config.yml` ([example file](https://github.com/Varying-Vagrant-Vagrants/VVV/blob/develop/config/default-config.yml)) and reprovisioning. To test changes to the core provisioner, delete the `provision/utilities/core` folder, then change the `config/config.yml` file to match the repo and branch you'd like to test: @@ -39,6 +39,17 @@ Then, halt the VM and reprovision: `vagrant halt && vagrant up --provision` ## Custom Site Template ```yaml + wordpress-two: + skip_provisioning: false + description: "A standard WP install, useful for building plugins, testing things, etc" + repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template.git + custom: + # locale: it_IT + delete_default_plugins: true + install_plugins: + - query-monitor + hosts: + - two.wordpress.test ``` If the pull request adds new parameters, check that they work as expected, and check that things still work if the parameter is missing/blank. @@ -46,4 +57,10 @@ If the pull request adds new parameters, check that they work as expected, and c ## Custom Site Template Develop ```yaml + wordpress-trunk: + skip_provisioning: true # provisioning this one takes longer, so it's disabled by default + description: "An svn based WP Core trunk dev setup, useful for contributor days, Trac tickets, patches" + repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template-develop.git + hosts: + - trunk.wordpress.test ``` From bd8601c8dd7be8f1f01065f06d09eec9bed18cdc Mon Sep 17 00:00:00 2001 From: Daniele Scasciafratte Date: Wed, 2 Sep 2020 14:54:08 +0200 Subject: [PATCH 3/3] added explanation for dev template --- docs/en-US/troubleshooting/testing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en-US/troubleshooting/testing.md b/docs/en-US/troubleshooting/testing.md index ecd0400..637c661 100644 --- a/docs/en-US/troubleshooting/testing.md +++ b/docs/en-US/troubleshooting/testing.md @@ -64,3 +64,5 @@ If the pull request adds new parameters, check that they work as expected, and c hosts: - trunk.wordpress.test ``` + +This template generate a log of different logs to simplify the debugging and the output in console, for a better testing is better to check the log in `VVV/log/provisioners//provisioner-site-wordpress-trunk.log` and the other files generated.