Skip to content
Snippets Groups Projects
Commit 2c08613d authored by totten's avatar totten
Browse files

Rename "testing/setup.md" to "testing/index.md"

parent 5bb81841
Branches
No related tags found
No related merge requests found
......@@ -44,7 +44,7 @@ Make sure to check [the contribution guidelines](/core/contributing.md) for more
**Install the [buildkit](https://github.com/civicrm/civicrm-buildkit)**, ideally as a [vagrant virtual-machine](https://github.com/civicrm/civicrm-buildkit-vagrant) or using one of available `docker` images ([progressivetech](https://github.com/progressivetech/docker-civicrm-buildkit) or [EricBSchulz](https://github.com/ErichBSchulz/dcbk)). The buildkit is not an absolute requirement but it is definitely the fastest path to a good development experience!
**From the outset, [automate testing](/testing/setup.md)**. In the current climate of rapid evolution of not just CiviCRM, but also it's myriad of dependencies, automated testing of PHP code with `phpunit` and javascript with tools like `karma` and `jasmine` is essential. Start all your work by considering how you will provide automated testing for it. Starting with the buildkit will make this much simpler for you to set up. Getting started with unit-testing may seem daunting and onerous when you start, but you will soon come to love the freedom it gives you. If you are unsure how to proceed with testing ask the [community](/basics/community.md).
**From the outset, [automate testing](/testing/index.md)**. In the current climate of rapid evolution of not just CiviCRM, but also it's myriad of dependencies, automated testing of PHP code with `phpunit` and javascript with tools like `karma` and `jasmine` is essential. Start all your work by considering how you will provide automated testing for it. Starting with the buildkit will make this much simpler for you to set up. Getting started with unit-testing may seem daunting and onerous when you start, but you will soon come to love the freedom it gives you. If you are unsure how to proceed with testing ask the [community](/basics/community.md).
**Create a native [extension](/extensions/index.md)**. If you have new functionality to add to CiviCRM, it probably belongs in an extension. "Native" extensions will install into all CiviCRM sites regardless of the underlying CMS used (Drupal, WordPress, Joomla or Backdrop), making it easy to share your extension with the CiviCRM community.
......
......@@ -21,7 +21,7 @@ Your changes might require documentation updates. Read about [when to document](
Before you write any code you should write tests. You can use your plain-language description of how things should work to create automated tests for the feature.
CiviCRM comes with a variety of [testing tools](/testing/setup.md) that help ensure that changes don't break existing functionality. Since CiviCRM [doesn't release code with failing tests](/tools/jenkins.md), your bug or improvement must not be covered in the existing tests. Maybe there are incomplete tests, maybe the tests aren't valid measures of the functionality, or maybe your feature lacks test coverage. Either way, you will need to write them to make sure your work doesn't get undermined by future changes.
CiviCRM comes with a variety of [testing tools](/testing/index.md) that help ensure that changes don't break existing functionality. Since CiviCRM [doesn't release code with failing tests](/tools/jenkins.md), your bug or improvement must not be covered in the existing tests. Maybe there are incomplete tests, maybe the tests aren't valid measures of the functionality, or maybe your feature lacks test coverage. Either way, you will need to write them to make sure your work doesn't get undermined by future changes.
Use your documentation to identify tests that can be run, and then write them. If you are adding functionality, you may not have the code that the test will call, but you can write your tests as if all the pages and functions exist, defining them later.
......
......@@ -16,7 +16,7 @@ are supported for accessing the api functions
- There are a number of (fairly new) helper functions you should use
in the test - please check [Writing a PHPUnit testcase
HOWTO](/testing/setup.md)
HOWTO](/testing/index.md)
- API functions should match the relevant BAO names & have the
functions 'get', 'create' and delete'
- All functions should receive $params as an array(not a reference)
......
File moved
......@@ -15,4 +15,4 @@ Pull-requests are tested automatically with build-bot software called [Jenkins](
* There are a handful of unit tests which are time-sensitive and which fail sporadically. See: https://forum.civicrm.org/index.php?topic=36964.0
* The web test suite (`WebTest_AllTests`) takes several hours to execute. [It runs separately -- after the PR has been merged.](https://test.civicrm.org/job/CiviCRM-WebTest-Matrix/)
For detailed discussion about automated tests, see [Testing](/testing/setup.md)
For detailed discussion about automated tests, see [Testing](/testing/index.md)
......@@ -182,7 +182,7 @@ pages:
- hook_civicrm_tokenValues: hooks/hook_civicrm_tokenValues.md
- hook_civicrm_unhandledException: hooks/hook_civicrm_unhandledException.md
- Testing:
- Testing Setup: testing/setup.md
- Testing: testing/index.md
- PHPUnit Tests: testing/phpunit.md
- Javascript Tests: testing/javascript.md
- Selinium Tests: testing/selinium.md
......
......@@ -5,6 +5,7 @@ best-practices/documentation-style-guide documentation/style-guide
extensions/basics extensions
api/general api
hooks/hook_civicrm_trigger_info hooks/hook_civicrm_triggerInfo
testing/setup testing/index
framework/schema-definition framework/database/schema-definition
api/params api/options
core/develop tools/git
......
Documentation+Infrastructure+Canary develop
Book+style+guide best-practices/documentation-style-guide
CiviCRM+Unit+Testing+basic+information testing/setup
Writing+a+PHPUnit+testcase+HOWTO testing/setup
CiviCRM+Unit+Testing+basic+information testing/index
Writing+a+PHPUnit+testcase+HOWTO testing/index
Pull-Request+Process tools/git/#pr
......@@ -128,7 +128,7 @@ CiviRules+hooks hooks
Profile+Hooks hooks
Report+Hooks hooks
Tests+in+phpstorm tools/phpstorm/#testing
Testing testing/setup
Testing testing/index
PHP+Code+and+Inline+Documentation standards/php
Upgrade+Reference framework/upgrade
Bootstrap+Reference framework/bootstrap
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment