Skip to content

Commit 3933cad

Browse files
committed
Changed composer link, started writing phpunit install instructions
1 parent 214b12c commit 3933cad

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

_docs/developer/testing/linting_static_analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The following instructions were tested for Windows:
5858

5959
1. First, you will need PHP installed on your host system first. See [Installing PHP](/developer/testing/install_php)*
6060

61-
2. Next, you will need [Composer](https://getcomposer.org/doc/00-intro.md) installed on your host system as well.
61+
2. Next, you will need [Composer](https://getcomposer.org/download/) installed on your host system as well.
6262
During this install, you will need to change settings in a php.ini file. Change the settings the prompt recommends.
6363

6464
3. Run ``composer global require slevomat/coding-standard`` and ``composer global require "squizlabs/php_codesniffer=*"`` inside your terminal.

_docs/developer/testing/php_unit_tests.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,25 @@ category: Developer > Development Instructions > Continuous Integration Testing
66
To validate the unit behavior of the site code, we utilize
77
[phpunit](https://phpunit.readthedocs.io/en/latest).
88

9+
### Dependencies
910

10-
### Running PHP Unit Tests
11+
Before running PHP Unit Tests, you must install the required dependencies. You may either run your tests locally or inside the VM:
12+
13+
##### Inside the Vagrant VM
14+
15+
1. Install [Composer](https://getcomposer.org/download/) through the command-line installation copy-paste.
16+
2. `cd` to `/usr/local/submitty/GIT_CHECKOUT/Submitty/site/`
17+
3. run `composer update`
1118

12-
*You will need PHP installed on your host system first, see [Installing PHP](/developer/testing/install_php)*
19+
*Please be aware that many unit tests will not work inside the VM. It is suggested that you run tests individually.*
20+
21+
##### On Your Local Machine
22+
23+
### Running PHP Unit Tests
1324

14-
To run the PHP unit test suite locally, `cd` to the `Submitty/site` directory and type:
25+
*If you are running on WSL and are seeing errors, remove `php` from the following commands.*
1526

16-
If you are running on WSL and are seeing errors, remove "`php`" from the following commands.
27+
To run the PHP unit test suite locally, `cd` to `/usr/local/submitty/GIT_CHECKOUT/Submitty/site/` and type:
1728

1829
```
1930
php vendor/bin/phpunit

0 commit comments

Comments
 (0)