3 |
97 |
98 |
99 |
171 |
--------------------------------------------------------------------------------
/src/resources/assets/js/components/Log.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
38 |
39 |
5 |
37 |
6 |
10 |
11 |
7 | Projects
8 |
9 |
12 |
36 |
13 |
24 |
14 |
19 |
23 |
20 |
21 |
22 |
25 |
35 |
26 | toggle
27 |
28 |
29 | run
30 |
31 |
32 | reset
33 |
34 |
40 |
46 |
47 |
41 |
45 |
42 |
44 | NO PROJECTS FOUND
43 |
48 |
96 |
49 |
95 |
50 |
94 |
51 |
93 | -
52 |
-
57 | 58 |90 |59 | 65 | 66 | {{ project.name }} 67 |68 |69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 |89 |
91 |
3 |
84 |
85 |
86 |
159 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # TDDD - Test Driven Development Dashboard
2 | ### A Self-Hosted TDD Dashboard & Tests Watcher
3 |
4 | [](https://packagist.org/packages/pragmarx/tddd)
5 | [](LICENSE.md)
6 | [](https://packagist.org/packages/pragmarx/tddd)
7 | [](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master)
8 | [](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master)
9 | [](https://styleci.io/repos/27037779)
10 |
11 | ## What is it?
12 |
13 | TDD Dashboard, is an app (built as a Laravel PHP package) to watch and run all your tests during development. It supports any test framework working on terminal, and comes with some testers (PHPUnit, phpspec, behat, Jest, AVA...) preconfigured, but you can easily add yours, just tell it where the executable is and it's done. It also shows the progress of your tests, let you run a single test or all of them, and open your favorite code editor (PHPStorm, VSCode, Sublime Text, etc.) going right to the failing line of your test. If your test framework generate screenshots, it is also able to show it in the log page, with all the reds and greens you are used to see in your terminal.
14 |
15 | It uses Laravel as motor, but supports (and has been tested with) many languages, frameworks and testing frameworks:
16 |
17 | * [PHPUnit](https://phpunit.de/)
18 | * [Laravel & Laravel Dusk](https://laravel.com/docs/5.5/dusk)
19 | * [Codeception](http://codeception.com/)
20 | * [phpspec](http://www.phpspec.net/en/stable/)
21 | * [Behat](http://behat.org/en/latest/)
22 | * [atoum](http://atoum.org/)
23 | * [Jest](https://facebook.github.io/jest/)
24 | * [AVA](https://github.com/avajs/ava)
25 | * [React](https://reactjs.org/)
26 | * [Ruby on Rails](http://guides.rubyonrails.org/testing.html)
27 | * [Nette Tester](https://tester.nette.org/)
28 | * [Symfony](https://symfony.com/doc/current/testing.html)
29 |
30 | ## Features
31 |
32 | * Project List: click a project link to see all its tests.
33 | * Open files directly in your source code editor (PHPStorm, Sublime Text...).
34 | * Error log with source code linked, go strait to the error line in your source code.
35 | * Enable/disable a test. Once disabled if the watcher catches a change in resources, that test will not fire.
36 | * Real time test state: "idle", "running", "queued", "ok" and "failed".
37 | * "Show" button, to display the error log of failed tests.
38 | * Highly configurable, watch anything and test everything!
39 |
40 | ### Videos
41 |
42 | - [Preview](https://www.youtube.com/watch?v=sO_aDf3xCgE)
43 | - [Installing](https://youtu.be/AgkKCLNiV8w)
44 | - [VueJS Preview](https://youtu.be/HAdfLYArk_A)
45 | - [Laravel Dusk Preview](https://youtu.be/ooF4oLD9U7Q)
46 |
47 | ### Screenshots
48 |
49 | #### Dashboard
50 |
51 | 
52 |
53 | #### Error Log
54 | 
55 |
56 | 
57 |
58 | 
59 |
60 | ## Command Line Interface
61 |
62 | The Artisan commands **Watcher** and **Tester** are responsible for watching resources and firing tests, respectively:
63 |
64 | ### Watcher
65 |
66 | Keep track of your files and enqueue your tests every time a project or test file is changed. If a project file changes, it will enqueue all your tests, if a test file changes, it will enqueue only that particular test. This is how you run it:
67 |
68 | ``` bash
69 | php artisan tddd:watch
70 | ```
71 |
72 | ### Tester
73 |
74 | Responsible for taking tests from the run queue, execute it and log the results. Tester will only execute enabled tests. This is how you run it:
75 |
76 | ``` bash
77 | php artisan tddd:test
78 | ```
79 |
80 | ### Notifications
81 |
82 | It uses JoliNotif, so if it's not working on macOS, you can try installing terminal-notifier:
83 |
84 | ``` bash
85 | brew install terminal-notifier
86 | ```
87 |
88 | ## Test Framework Compatibility
89 |
90 | This package was tested and is known to be compatible with
91 |
92 | * [Codeception](http://codeception.com/)
93 | * [PHPUnit](https://phpunit.de/)
94 | * [phpspec](http://www.phpspec.net/)
95 | * [behat](http://docs.behat.org/)
96 | * [atoum](https://github.com/atoum/atoum)
97 | * [Nette Tester](http://tester.nette.org/en/)
98 |
99 | ## Installing
100 |
101 | #### TL;DR
102 |
103 | ``` bash
104 | laravel new tddd
105 | cd tddd
106 | composer require pragmarx/tddd
107 | php artisan vendor:publish --provider="PragmaRX\Tddd\Package\ServiceProvider"
108 | valet link tddd
109 | # configure database on your .env
110 | php artisan migrate
111 | php artisan tddd:watch & php artisan tddd:work &
112 | open http://tddd.dev/tests-watcher/dashboard
113 | ```
114 |
115 | ### Examples & Starter App
116 |
117 | For lots of examples, check [this starter app](https://github.com/antonioribeiro/tests-watcher-starter), which will also help you create an independent dashboard for your tests.
118 |
119 | ### The long version
120 |
121 | Require it with [Composer](http://getcomposer.org/):
122 |
123 | ``` bash
124 | composer require pragmarx/tddd
125 | ```
126 |
127 | Create a database, configure on your Laravel app and migrate it
128 |
129 | ``` bash
130 | php artisan migrate
131 | ```
132 |
133 | Publish Ci configuration:
134 |
135 | On Laravel 4.*
136 |
137 | Add the service provider to your app/config/app.php:
138 |
139 | ``` php
140 | 'PragmaRX\Tddd\Package\ServiceProvider',
141 | ```
142 |
143 | ``` bash
144 | php artisan config:publish pragmarx/tddd
145 | ```
146 |
147 | On Laravel 5.*
148 |
149 | ``` bash
150 | php artisan vendor:publish --provider="PragmaRX\Tddd\Package\ServiceProvider"
151 | ```
152 |
153 | ## Example of projects
154 |
155 | ### Laravel Dusk
156 |
157 | ``` php
158 | 'project bar (dusk)' => [
159 | 'path' => $basePath,
160 | 'watch_folders' => [
161 | 'app',
162 | 'tests/Browser'
163 | ],
164 | 'exclude' => [
165 | 'tests/Browser/console/',
166 | 'tests/Browser/screenshots/',
167 | ],
168 | 'depends' => [],
169 | 'tests_path' => 'tests',
170 | 'suites' => [
171 | 'browser' => [
172 | 'tester' => 'dusk',
173 | 'tests_path' => 'Browser',
174 | 'command_options' => '',
175 | 'file_mask' => '*Test.php',
176 | 'retries' => 0,
177 | ],
178 | ],
179 | ],
180 | ```
181 |
182 | ## Troubleshooting
183 |
184 | #### Tests are running fine in terminal but failing in the dashboard?
185 |
186 | You have first to remember they are being executed in isolation, and, also, the environment is not exactly the same, so things like a cache and session may affect your results.
187 |
188 | ## Requirements
189 |
190 | - Laravel 4.1+ or 5
191 | - PHP 5.3.7+
192 |
193 | ## Author
194 |
195 | [Antonio Carlos Ribeiro](http://twitter.com/iantonioribeiro)
196 |
197 | ## License
198 |
199 | Laravel Ci is licensed under the BSD 3-Clause License - see the `LICENSE` file for details
200 |
201 | ## Contributing
202 |
203 | Pull requests and issues are welcome.
204 |
205 |
206 |
207 |
208 |
--------------------------------------------------------------------------------
/src/package/Data/Repositories/Support/Tests.php:
--------------------------------------------------------------------------------
1 | getRelativePathname())
24 | ->where('suite_id', $suite->id)
25 | ->first();
26 |
27 | return $exists;
28 | }
29 |
30 | /**
31 | * Create or update a test.
32 | *
33 | * @param \Symfony\Component\Finder\SplFileInfo $file
34 | * @param \PragmaRX\Tddd\Package\Data\Models\Suite $suite
35 | *
36 | * @return bool
37 | */
38 | public function createOrUpdateTest($file, $suite)
39 | {
40 | $test = Test::where('path', $path = $this->normalizePath($file->getPath()))
41 | ->where('name', $name = trim($file->getFilename()))
42 | ->first();
43 |
44 | if (is_null($test)) {
45 | $test = Test::create([
46 | 'sha1' => sha1("$path/$name"),
47 | 'path' => $path,
48 | 'name' => $name,
49 | 'suite_id' => $suite->id,
50 | ]);
51 | }
52 |
53 | if ($test->wasRecentlyCreated && $this->findTestByFileAndSuite($file, $suite)) {
54 | $this->addTestToQueue($test);
55 | }
56 |
57 | return $test->wasRecentlyCreated;
58 | }
59 |
60 | /**
61 | * Sync all tests.
62 | *
63 | * @param $exclusions
64 | */
65 | public function syncTests($exclusions, $showTests)
66 | {
67 | foreach ($this->getSuites() as $suite) {
68 | $this->syncSuiteTests($suite, $exclusions, $showTests);
69 | }
70 | }
71 |
72 | /**
73 | * Check if a file is a test file.
74 | *
75 | * @param $path
76 | *
77 | * @return \___PHPSTORM_HELPERS\static|bool|mixed
78 | */
79 | public function isTestFile($path)
80 | {
81 | if (file_exists($path)) {
82 | foreach (Test::all() as $test) {
83 | if ($test->fullPath == $path) {
84 | return $test;
85 | }
86 | }
87 | }
88 |
89 | return false;
90 | }
91 |
92 | /**
93 | * Store the test result.
94 | *
95 | * @param $run
96 | * @param $test
97 | * @param $lines
98 | * @param $ok
99 | * @param $startedAt
100 | * @param $endedAt
101 | *
102 | * @return mixed
103 | */
104 | public function storeTestResult($run, $test, $lines, $ok, $startedAt, $endedAt)
105 | {
106 | if (!$this->testExists($test)) {
107 | return false;
108 | }
109 |
110 | $run = $this->updateRun($run, $test, $lines, $ok, $startedAt, $endedAt);
111 |
112 | $test->state = $ok ? Constants::STATE_OK : Constants::STATE_FAILED;
113 |
114 | $test->last_run_id = $run->id;
115 |
116 | $test->save();
117 |
118 | $this->removeTestFromQueue($test);
119 |
120 | return $ok;
121 | }
122 |
123 | /**
124 | * Mark a test as being running.
125 | *
126 | * @param $test
127 | *
128 | * @return mixed
129 | */
130 | public function markTestAsRunning($test)
131 | {
132 | $test->state = Constants::STATE_RUNNING;
133 |
134 | $test->save();
135 |
136 | return $this->createNewRunForTest($test);
137 | }
138 |
139 | /**
140 | * Find a test by name and suite.
141 | *
142 | * @param $suite
143 | * @param $file
144 | *
145 | * @return mixed
146 | */
147 | protected function findTestByNameAndSuite($file, $suite)
148 | {
149 | return Test::where('name', $file->getRelativePathname())->where('suite_id', $suite->id)->first();
150 | }
151 |
152 | /**
153 | * Enable tests.
154 | *
155 | * @param $enable
156 | * @param $project_id
157 | * @param null $test_id
158 | *
159 | * @return bool
160 | */
161 | public function enableTests($enable, $project_id, $test_id)
162 | {
163 | $enable = is_bool($enable) ? $enable : ($enable === 'true');
164 |
165 | $tests = $this->queryTests($project_id, $test_id == 'all' ? null : $test_id)->get();
166 |
167 | foreach ($tests as $test) {
168 | $this->enableTest($enable, $test);
169 | }
170 |
171 | return $enable;
172 | }
173 |
174 | /**
175 | * Run a test.
176 | *
177 | * @param $test
178 | * @param bool $force
179 | */
180 | public function runTest($test, $force = false)
181 | {
182 | if (!$test instanceof Test) {
183 | $test = Test::find($test);
184 | }
185 |
186 | $this->addTestToQueue($test, $force);
187 | }
188 |
189 | /**
190 | * Enable a test.
191 | *
192 | * @param $enable
193 | * @param \PragmaRX\Tddd\Package\Data\Models\Test $test
194 | */
195 | protected function enableTest($enable, $test)
196 | {
197 | $test->timestamps = false;
198 |
199 | $test->enabled = $enable;
200 |
201 | $test->save();
202 |
203 | if (!$enable) {
204 | $this->removeTestFromQueue($test);
205 |
206 | return;
207 | }
208 |
209 | if ($test->state !== Constants::STATE_OK) {
210 | $this->addTestToQueue($test);
211 | }
212 | }
213 |
214 | /**
215 | * Query tests.
216 | *
217 | * @param $test_id
218 | *
219 | * @return mixed
220 | */
221 | protected function queryTests($projects, $test_id = null)
222 | {
223 | $projects = (array) $projects;
224 |
225 | $query = Test::select('tddd_tests.*')
226 | ->join('tddd_suites', 'tddd_suites.id', '=', 'tddd_tests.suite_id');
227 |
228 | if ($projects && $projects != 'all') {
229 | $query->whereIn('tddd_suites.project_id', $projects);
230 | }
231 |
232 | if ($test_id && $test_id != 'all') {
233 | $query->where('tddd_tests.id', $test_id);
234 | }
235 |
236 | return $query;
237 | }
238 |
239 | /**
240 | * Mark tests as notified.
241 | *
242 | * @param $tests
243 | */
244 | public function markTestsAsNotified($tests)
245 | {
246 | $tests->each(function ($test) {
247 | $test['run']->notified_at = Carbon::now();
248 |
249 | $test['run']->save();
250 | });
251 | }
252 |
253 | /**
254 | * Check if the test exists.
255 | *
256 | * @param $test
257 | *
258 | * @return bool
259 | */
260 | protected function testExists($test)
261 | {
262 | return !is_null(Test::find($test->id));
263 | }
264 |
265 | /**
266 | * Update the run.
267 | *
268 | * @param $run
269 | * @param $test
270 | * @param $lines
271 | * @param $ok
272 | * @param $startedAt
273 | * @param $endedAt
274 | *
275 | * @return mixed
276 | */
277 | private function updateRun($run, $test, $lines, $ok, $startedAt, $endedAt)
278 | {
279 | $run->test_id = $test->id;
280 | $run->was_ok = $ok;
281 | $run->log = $this->formatLog($lines, $test) ?: '(empty)';
282 | $run->html = $this->getOutput($test, $test->suite->tester->output_folder,
283 | $test->suite->tester->output_html_fail_extension);
284 | $run->screenshots = $this->getScreenshots($test, $lines);
285 | $run->started_at = $startedAt;
286 | $run->ended_at = $endedAt;
287 |
288 | $run->save();
289 |
290 | return $run;
291 | }
292 | }
293 |
--------------------------------------------------------------------------------
4 |
83 |
5 |
82 |
6 |
18 |
19 | 7 | {{ selectedProject.name }} - {{ selectedTest.name }} 8 |
9 | 10 |11 | 12 | 13 | 14 | {{ selectedTest.state }} 15 | 16 |
17 |
20 |
75 |
76 |
81 |
21 |
49 |
50 |
22 |
38 |
39 |
23 | command output
24 |
25 |
26 |
27 | screenshots
28 |
29 |
30 |
31 | coverage
32 |
33 |
34 |
35 | {{ getHtmlPaneName() }}
36 |
37 |
40 |
43 |
44 |
48 |
45 | open in {{ selectedTest.editor_name }}
46 |
47 |
51 |
74 |
52 |
53 |
54 |
55 |
60 |
61 |
56 | ![]()
58 |
59 | {{ String(screenshot).substring(screenshot.lastIndexOf('/') + 1) }}
57 |
62 |
69 |
70 |
71 |
72 |
73 |