RedHatTraining/rht-labs-docs.git

Ravi Srinivasan

2019-01-31 6881932dbcdcd9fdd65e31f8a9de33b8c1e8d5f1

commit \| author \| age
15c296	1	# Revenge Of The Automated Testing
5a16fd	2
969f3f	3	> The purpose of this exercise is to develop and validate a new feature using Test Driven Development (TDD); and to promote the assured feature through the pipeline.
01245c	4
969f3f	5	<!-- ![comic-header](../images/exercise3/comic-header.png)
9e07af	6
969f3f	7	[Image Source](https://cdn-images-1.medium.com/max/1600/1*wF_fSCH-gLYfMbkwb3gR2w.png) -->
9e07af	8
aea5c5	9	## Introduction to TDD.
D	10
969f3f	11	<!-- > _Here is a brief introduction of TDD and why we use it._ -->
aea5c5	12
D	13	Test Driven Development (TDD) is a software development process that relies on the repetition of a very short development cycle. Requirements are turned into test cases, where the software is developed to pass the tests. In other words, it creates a safety net that serves to keep the developer's problems/bugs at bay while enabling the developer to refactor efficiently. This is opposed to software development that allows software to be added that is not proven to meet requirements.
	14
969f3f	15	The TDD cycle can be illustrated with the following diagram:
RS	16
aea5c5	17	![TDD-diagram](../images/exercise3/TDD-lifecycle.jpg)
D	18
5e7a31	19	### The TDD Cycle
aea5c5	20
D	21	1. `Write a test` -
853f0c	22	In TDD a new feature begins by writing a test. Write a test that clearly defines a function or one that provides an improvement to an existing function. It's important the developer clearly understands the feature's specification and requirements, or the feature could be wrong from the get-go.
aea5c5	23
D	24	2. `Test Fails` -
5e7a31	25	When a test is first implemented it is expected to fail. This failure validates the test is working correctly as the feature is yet to be implemented.
aea5c5	26
D	27	3. `Write code to make test pass` -
	28	This step involves implementing the feature to pass the failed test. Code written at this stage may be inelegant and still pass the test, however this is acceptable as TDD is a recursive cycle which includes code refactoring.
	29
	30	4. `Code Passes tests` -
	31	If all tests pass, the developer can be confident that the new code meets the test requirements.
	32
	33	5. `Refactor` -
f23c14	34	The refactoring step will allow the developer to clean up their code without changing its behaviour. Not changing the behaviour should ensure the tests still pass. The process of refactoring can include; removal of duplication, renaming of object, class, module, variable and method names to clearly represent their current purpose and use, decoupling of functionality and increasing code cohesion.
aea5c5	35
D	36	6. `Repeat` -
	37	Starting with another new test, the cycle is then repeated to push forward the functionality. The size of the steps should always be small, with as few as 1 to 10 edits between each test run. If new code does not rapidly satisfy a new test, or other tests fail unexpectedly, the programmer should undo or revert in preference to excessive debugging.
	38
	39	### Testing Bananalogy
5e7a31	40	Explanation of Mocha and JS test syntax through Bananalogy! Imagine for a moment; we're not building software but creating a bowl of fruit. To create a `Bunch of Bananas` component for our fruit bowl we could start with our tests as shown below.
969f3f	41
aea5c5	42	![bdd-bananas](../images/exercise3/bdd-bananas.png)
969f3f	43
aea5c5	44	* `describe` is used to group tests together. The string `"a bunch of ripe bananas"` is for human reading and allows you to identify tests.
D	45	* `it` is a statement that contains a test. It should contain an assertion such as `expect` or `should`. It follows the syntax of `describe` where the string passed in identifies the statement.
01245c	46
D	47	---
5a16fd	48
D	49	## Learning Outcomes
01245c	50
5a16fd	51	As a learner you will be able to
01245c	52
142de4	53	* Understand the why behind TDD
936424	54	* Implement a feature using TDD for front end and backend
142de4	55	* Write end to end tests for the feature and run them in CI
5a16fd	56
D	57	## Tools and Frameworks
01245c	58
969f3f	59	<!-- > Name of tool - short description and link to docs or website -->
5a16fd	60
142de4	61	1. [Jest](https://facebook.github.io/jest/) - Zero configuration testing platform
D	62	Jest is used by Facebook to test all JavaScript code including React applications. One of Jest's philosophies is to provide an integrated "zero-configuration" experience. We observed that when engineers are provided with ready-to-use tools, they end up writing more tests, which in turn results in more stable and healthy code bases.
	63	1. [Vue Test Utils](https://vue-test-utils.vuejs.org/en/) - Vue Test Utils is the official unit testing utility library for Vue.js.
	64	1. [Nightwatch.js](http://nightwatchjs.org/) - Nightwatch.js is an easy to use Node.js based End-to-End (E2E) testing solution for browser based apps and websites. It uses the powerful W3C WebDriver API to perform commands and assertions on DOM elements.
	65	1. [Mocha](https://mochajs.org/) - Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun. Mocha tests run serially, allowing for flexible and accurate reporting, while mapping uncaught exceptions to the correct test cases. Hosted on GitHub.
5e7a31	66	1. [Sinon](http://sinonjs.org/) - Standalone test spies, stubs and mocks for JavaScript.
142de4	67	Works with any unit testing framework.
5a16fd	68
D	69	## Big Picture
1a8071	70	> From the previous exercise; we created a simple pipeline. We will now flesh it out with some testing to add gates to our pathway to production.
01245c	71
1a8071	72	![big-picture](../images/big-picture/big-picture-3.jpg)
5a16fd	73
01245c	74	---
5a16fd	75
D	76	## 10,000 Ft View
	77
a9efee	78	> The goal of this exercise is to add a new component to the application using TDD to create and validate its behaviour. The User story we have been given is as follows:
5a16fd	79
5e7a31	80	As a doer I want to mark todos as important so that I can keep track of and complete high priority todos first
01245c	81
142de4	82	_Acceptance Criteria_
D	83	- [ ] should be doable with a single click
	84	- [ ] should add a red flag against the todo when marked important
	85	- [ ] should remove the red colour flag on the flag when important removed
	86	- [ ] should not affect existing todos
	87
	88	_On page load:_
	89	- [ ] should display existing todos that are not marked important
	90	- [ ] should display existing todos that are marked important with an red flag
5a16fd	91
D	92	## Step by Step Instructions
969f3f	93	<!-- > This is a fairly structured guide with references to exact filenames and sections of text to be added. -->
5a16fd	94
01245c	95	### Part 1 - Tests in our Pipeline
936424	96	> _In this part we will get familiar with the layout of our tests. We will also improve the pipeline created already by adding some unit tests for the front end & backend along with some end to end tests (e2e) to validate the full solution_
5a16fd	97
969f3f	98	#### 1a - Todo List Front End Unit tests
936424	99	> In this exercise we will execute our test for the front end locally. Once verified we will add them to Jenkins.
d1565e	100
1a8071	101	1. Before linking our automated testing to the pipeline we'll first ensure the tests run locally. Change to the `todolist-fe` directory and run `test`.
3050f4	102	```bash
58480f	103	cd todolist-fe
D	104	```
	105	```bash
	106	npm run test
3050f4	107	```
5e7a31	108	<p class="tip" >
8fc8df	109	`test` is an alias used that runs `vue-cli-service test` from the scripts object in `package.json`
3050f4	110	</p>
969f3f	111
aea5c5	112	![screenshot-scripts](../images/exercise3/screenshot-scripts.png)
D	113
936424	114	2. This command will run all `spec.js` files. Our test files are stored in the following places. There are 12 front end test files stored in these directories: `todolist-fe/tests/unit/vue-components/` & `todolist-fe/tests/unit/javascript/*`
d1565e	115
969f3f	116	3. You should see an output similar to the following. The above command has run a test suite for every `*.spec.js` file. The table generated in the terminal shows the code coverage. We're going to be focusing on the unit tests for now.
RS	117
aea5c5	118	![test-run-locally](../images/exercise3/test-run-locally.png)
3050f4	119
969f3f	120	4. Repeat the same process for `todolist-api` and verify that all the tests run. If you have an ExpressJS server already running from previous exercise; you should kill it before running the tests. The `mocha` test suite will launch a dev server for running the tests. There are 2 API test files: `todolist-api/server/api/todo/todo.spec.js` & `todolist-api/server/mocks/mock-routes.spec.js` for our API and the Mocks server. Remember to start the `mongo` container before running the tests
RS	121	```bash
	122	npm run mongo:start
	123	```
3050f4	124	```bash
58480f	125	cd todolist-api
D	126	```
	127	```bash
	128	npm run test
3050f4	129	```
b81187	130
969f3f	131	> NOTE: On Windows systems, tests will fail because Mocha is unable to find the `.spec.js` files. Edit the `package.json` file, and remove the single quotes around `server//.spec.js` in the `test` line as follows:
RS	132
	133	```bash
	134	"test": "node_modules/.bin/nyc node_modules/.bin/mocha server/*/.spec.js --exit"
	135	```
	136
	137	5. Navigate to your instance of Jenkins at `https://jenkins-<YOUR_NAME>-ci-cd.<APPS_URL>`.
3050f4	138	Click on `dev-todolist-fe-build` and then click the `configure` button on the left-hand side.
969f3f	139
aea5c5	140	![jenkins-configure-job](../images/exercise3/jenkins-configure-job.png)
3050f4	141
969f3f	142	6. Scroll to the `Build` part of the configuration page and add `npm run test` below `npm install`.
RS	143
aea5c5	144	![jenkins-build-step](../images/exercise3/jenkins-build-step.png)
3050f4	145
969f3f	146	7. Scroll to the `Post-build Actions` section and click `Add post-build action`. Select `Publish xUnit test result report` (Jenkins might place this at the top of the `Post-build Actions` list).
RS	147
aea5c5	148	![xunit-action](../images/exercise3/xunit-action.png)
b81187	149
969f3f	150	8. Click the `Add` button under `Publish xUnit test result report` and select `JUnit`. In the pattern field enter `test-report.xml`. In the `Failed Tests Thresholds` input box enter 0 under `Red Ball Total`. It should look a little something like this:
RS	151
aea5c5	152	![post-build-actions](../images/exercise3/post-build-actions.png)
b81187	153
969f3f	154	9. Click `Save` at the bottom to save the changes. Run the `dev-todolist-fe-build` job and verify that this passes and the `build` and `bake` jobs are both triggered.
b81187	155
969f3f	156	<!-- #### (Optional) Failing the tests
65ddc2	157	> _If you're not very confident in your technical ability and want don't want to do the TDD lab; feel free to just do this next section. If you are confident jump on to the e2e testing section below_
a9627c	158
d82125	159	2. We're now going to deliberately fail a test to ensure that `bake` and `deploy` jobs aren't triggered if any tests fail. Open the `todolist-fe` source code in your favourite editor. Open `ListOfTodos.spec.js` in `/tests/unit/vue-components` and head to `line 39`. Add `not.` before `toHaveBeenCalled()` to fail the test.
aea5c5	160	![change-test-to-fail](../images/exercise3/change-test-to-fail.png)
b81187	161
0976ea	162	2. Push this to Gitlab and run the build job.
b81187	163	```bash
58480f	164	git add .
D	165	```
	166	```bash
	167	git commit -m "TEST - failing build with tests"
	168	```
	169	```bash
	170	git push
b81187	171	```
A	172
5e7a31	173	2. Rerun the `dev-todolist-fe-build` job. It should have failed and not run any other jobs.
aea5c5	174	![jenkins-with-failing-build](../images/exercise3/jenkins-with-failing-build.png)
b81187	175
5da0fd	176	2. You can examine the test results on the jobs home page. Drill down into the tests to see which failed and other useful stats
D	177	![fe-test-fails](../images/exercise3/fe-test-fails.png)
	178
969f3f	179	2. Undo the changes you made to the `ListOfTodos.spec.js` file, commit your code and rerun the build. -->
e1ba4f	180
969f3f	181	#### 1b - End to End Tests (e2e)
cad21a	182	> _Unit tests are a great way to get immediate feedback as part of testing an application. End to end tests that drive user behaviour are another amazing way to ensure an application is behaving as expected._
d1565e	183
969f3f	184	In this part of the exercise, we will add a new stage to our pipeline called `dev-todolist-fe-e2e` that will run after the deploy has been completed. End to end tests will use `Nightwatch.js` to orchestrate a selenium webdriver instance that controls the web browser; in this case Google Chrome!
f9d113	185
969f3f	186	1. Let's start by checking that our tests execute locally. On the terminal move to the `todolist-fe` folder. Our end to end tests are stored in `tests/e2e/specs/`. The vuejs cli uses Nightwatch.js and comes pre-configured to run tests against Google Chrome. We have created some additional configuration in the root of the project `nightwatch.config.js` to run headless in CI mode on Jenkins.
f9d113	187	```bash
58480f	188	cd todolist-fe
f9d113	189	```
D	190
	191	2. Run the tests locally by executing the following. This should start the dev server and run the test. You may see the browser pop up and close while tests execute.
	192	```bash
58480f	193	npm run e2e
f9d113	194	```
969f3f	195
4ce512	196	![local-e2e](../images/exercise3/local-e2e.png)
f9d113	197
969f3f	198	> NOTE: On Windows systems, you will see the firewall pop-up and ask permission to allow access. Click allow access to continue.
f9d113	199
969f3f	200
RS	201	3. With tests executing locally; let's add them to our Jenkins pipeline. To do this; we'll create a new job and connect it up to our `todolist-fe` jobs. Open Jenkins and create a `New Item` called `dev-todolist-fe-e2e`. Make this Job `Freestyle`.
	202
	203	4. On the configuration page (under the general tab); Set the Label for the job to run on as `jenkins-slave-npm`. Check the box marking the build parameterised and add a String parameter of `BUILD_TAG` as done before
	204
4ce512	205	![e2e-general](../images/exercise3/e2e-general.png)
d1565e	206
969f3f	207	5. On the Source Code Management tab; set the source code to git and add the url to your `todolist-fe` app. Set the branch to `refs/tags/${BUILD_TAG}`
RS	208
4ce512	209	![e2e-git](../images/exercise3/e2e-git.png)
D	210
969f3f	211	6. Set `Color ANSI Console Output` on the `Build Environment` section
4ce512	212
969f3f	213	7. On the Build section; add a build step to execute shell and fill in the following substituting `<YOUR_NAME>` accordingly:
4ce512	214	```bash
6c5da4	215	export E2E_TEST_ROUTE=todolist-fe-<YOUR_NAME>-dev.<APPS_URL>
7a3088	216	npm install
D	217	npm run e2e:ci
4ce512	218	```
D	219	![e2e-steps](../images/exercise3/e2e-steps.png)
	220
969f3f	221	8. Add a Post Build action to `Publish Junit test result report`. Add `reports/e2e/specs/*.xml` to the report location and save the configuration to be brought back to the Job's homepage.
RS	222
4ce512	223	![e2e-post-build](../images/exercise3/e2e-post-build.png)
D	224
969f3f	225	9. We want to connect the e2e job we just created to our dev pipleline by editing the post build actions on `dev-todolist-fe-deploy` job. Open the `dev-todolist-fe-deploy` job and hit `configure`. In the `Post-build actions` section of this job add a `Trigger parameterised build` on other jobs. Set the `Projects to build` to be `dev-todolist-fe-e2e`. Add a Parameter and set the it to the `Current build parameters`. Save the settings.
RS	226
a47ec2	227	![e2e-trigger](../images/exercise3/e2e-trigger.png)
D	228
969f3f	229	10. Run the pipeline from the beginning to see the e2e tests executed after deployment.
d1565e	230
142de4	231	### Part 2 - TodoList new feature
d1565e	232	> _In this exercise we will introduce a new feature to create an important flag on the todos. In order to be able to build and test our feature we will use TDD_
D	233
142de4	234	As a doer I want to mark todos as important so that I can keep track of and complete high prirority todos first
d1565e	235
142de4	236	_Acceptance Criteria_
D	237	- [ ] should be doable with a single click
	238	- [ ] should add a red flag against the todo when marked important
	239	- [ ] should remove the red colour flag on the flag when important removed
	240	- [ ] should not affect existing todos
d1565e	241
142de4	242	_On page load:_
D	243	- [ ] should display existing todos that are not marked important
	244	- [ ] should display existing todos that are marked important with an red flag
d1565e	245
752f2a	246	#### 2a - Create todolist-api tests
142de4	247	> Using [Mocha](https://mochajs.org/) as our test runner; we will now write some tests for backend functionality to persist our important-flag. The changes required to the backend are minimal but we will use TDD to create our test first, then implement the functionality.
01245c	248
969f3f	249	1. Create a new branch in your `todolist-api` app for our feature and push it to the remote
RS	250	```bash
	251	cd todolist-api
	252	```
d1565e	253	```bash
58480f	254	git checkout -b feature/important-flag
D	255	```
	256	```bash
	257	git push -u origin feature/important-flag
5a16fd	258	```
D	259
969f3f	260	2. Navigate to the `server/api/todo/todo.spec.js` file. This contains all of the existing todo list api tests. These are broken down into simple `describe("api definition", function(){})` blocks which is BDD speak for how the component being tested should behave. Inside of each `it("should do something ", function(){})` statements we use some snappy language to illustrate the expected behaviour of the test. For example a `GET` request of the api is described and tested for the return to be of type Array as follows.
RS	261
01245c	262	```javascript
D	263	describe("GET /api/todos", function() {
	264	it("should respond with JSON array", function(done) {
	265	request(app)
	266	.get("/api/todos")
	267	.expect(200)
	268	.expect("Content-Type", /json/)
	269	.end(function(err, res) {
	270	if (err) return done(err);
	271	// Test goes here
	272	res.body.should.be.instanceof(Array);
	273	done();
	274	});
142de4	275	});
01245c	276	});
D	277	```
	278	where:
775c6b	279	- `describe` is used to group tests together into a collection asserting some feature; for example the get all todos api.
D	280	- `it` is an individual test statement and should contain an `expect` or a `should` statement asserting behaviour of the API under test.
	281	- `request` is a library for making http calls to the api.
	282	- `.expect(200)` asserts the HTTP Return Code
	283	- `res.body.should.be.instanceof(Array);` is the actual test call
	284	- `done();` tells the test runner that `mocha` has finished execution. This is needed as the http calls are asynchronous.
5a16fd	285
5e7a31	286	3. With this knowledge; let's implement our test for the `important` flag. We expect the front end to introduce a new property on each `todo` that gets passed to the backend called `important`. The API will need to handle this new property and pass it into the mongodb. Let's begin implementing this functionality by writing our test case. Navigate to the `PUT /api/todos` section of the `server/api/todo/todo.spec.js` test file (which should be at the bottom)
969f3f	287
775c6b	288	![todo-api-tests](../images/exercise3/todo-api-tests.png)
01245c	289
969f3f	290	4. Before writing our test; let's first make sure all the existing tests are passing. Ensure that your MongoDB container is running before running the tests (using the `npm run mongo:*` scripts)
RS	291
142de4	292	```bash
58480f	293	npm run test
01245c	294	```
D	295
969f3f	296	5. With all the tests passing; let's add our new one. For ease of completing this exercise a template of a new test has been written at the very end of the file (just below the ` // Exercise 3 test case!` comment). A PUT request responds in our API with the data that it has just updated. So provided that MongoDB accepted the change, the API will respond with an object that has the `important` property on it. To write our test; edit the template test by completing the following:
9f3a7a	297	* Edit the `it("should ...")` to describe the important flag we're testing
01245c	298	* Edit the `.send()` to include `important: true` property
775c6b	299	* Edit the `.expect()` to be `.expect(200)`
01245c	300	* Add a new test assertion to check that `res.body.important` is `true` below the `// YOUR TEST GO HERE` line.
969f3f	301
01245c	302	```javascript
775c6b	303	// Exercise 3 test case!
142de4	304	it("should mark todo as important and persist it", function(done) {
01245c	305	request(app)
D	306	.put("/api/todos/" + todoId)
142de4	307	.send({
D	308	title: "LOVE endpoint/server side testing!",
	309	completed: true,
	310	important: true
	311	})
01245c	312	.expect(200)
D	313	.expect("Content-Type", /json/)
	314	.end(function(err, res) {
142de4	315	if (err) return done(err);
D	316	res.body.should.have.property("_id");
	317	res.body.title.should.equal("LOVE endpoint/server side testing!");
	318	// YOUR TEST GO HERE
	319	res.body.important.should.equal(true);
	320	done();
01245c	321	});
142de4	322	});
01245c	323	```
D	324
969f3f	325	6. Run your test. It should fail.
142de4	326	```bash
58480f	327	npm run test
01245c	328	```
969f3f	329
01245c	330	![fail-mocha](../images/exercise3/fail-mocha.png)
D	331
969f3f	332	7. With our test now failing; let's implement the feature. This is quite a simple change - we first need to update the `server/api/todo/todo.model.js`. Add an additional property on the schema called `important` and make its type Boolean.
RS	333
01245c	334	```javascript
D	335	const TodoSchema = new Schema({
142de4	336	title: String,
969f3f	337	completed: Boolean,
142de4	338	important: Boolean
01245c	339	});
D	340	```
9f3a7a	341
969f3f	342	8. Next we need to update the `server/config/seed.js` file so that the pre-generated todos have an important property. Add `important: false` below `completed: ` for each object. Don't forget to add a comma at the end of the `completed: ` line.
RS	343
9f3a7a	344	![api-add-seed-important](../images/exercise3/api-add-seed-important.png)
01245c	345
969f3f	346	9. With your changes to the Database schema updated; re-run your tests. The tests should pass.
142de4	347	```bash
58480f	348	npm run test
01245c	349	```
D	350
969f3f	351	10. Commit your code to the `feature/important-flag` branch and then merge onto the `develop` branch as follows
RS	352	<!-- <p class="tip">
01245c	353	NOTE - At this point in a residency we would peer review the code before pushing it to develop or master branch!
969f3f	354	</p> -->
142de4	355	```bash
58480f	356	git add .
D	357	```
	358	```bash
	359	git commit -m "ADD backend schema updates"
	360	```
	361	```bash
	362	git push
	363	```
	364	```bash
	365	git checkout develop
	366	```
	367	```bash
	368	git merge feature/important-flag
	369	```
	370	```bash
	371	git push
01245c	372	```
D	373
969f3f	374	<!-- 3. After pushing your changes; start back up the `todolist-api` app on a new terminal session
1329f3	375	```bash
58480f	376	npm run start
969f3f	377	``` -->
1329f3	378
936424	379	#### 2b - Create todolist-fe tests
5e7a31	380	> Using [Jest](https://facebook.github.io/jest/) as our test runner and the `vue-test-utils` library for managing our vue components; we will now write some tests for front end functionality to persist our important-flag. The changes required to the front end are quite large but we will use TDD to create our test first, then implement the functionality.
01245c	381
853f0c	382	Our TodoList App uses `vuex` to manage the state of the app's todos and `axios` HTTP library to connect to the backend. `Vuex` is an opinionated framework for managing application state and has some key design features you will need to know to continue with the exercise.
01245c	383
a9efee	384	In `vuex` the application state is managed by a `store`. The `store` houses all the todos we have retrieved from the backend as well as the `getter` methods for our array of `todos`. In order to make changes to the store, we could call the store directly and update each todo item but as earlier said; vuex is an opinionated module with its own way of updating the store. It is bad practice to call the store directly.
142de4	385
853f0c	386	There are two parts of the lifecycle to updating the store, the `actions` & `mutations`. When the user clicks a todo to mark it as complete; the `actions` are called. An action could involve a call to the backend or some pre-processing of the data. Once this is done, the change is committed to the store by calling the `mutation` function. A store should only ever be manipulated through a mutation function. Calling the mutation will then update the todo object in the app's local store for rendering in the view.
142de4	387
D	388	For example; when marking a todo as done in the UI, the following flow occurs
1329f3	389	* The `TodoItem.vue` calls the `markTodoDone()` function which dispatches an event to the store.
D	390	* This calls the `updateTodo()` function in the `actions.js` file
	391	* The action will update the backend db (calling our `todolist-api`) with our updated todo object.
	392	* The action will commit the change to the store by calling the mutation method `MARK_TODO_COMPLETED`
	393	* The `MARK_TODO_COMPLETED` will directly access the store object and update it with the new state value
	394	* The `ListOfTodos.vue` component is watching the store for changes and when something gets updated it re-renders the `TodoItem.vue`.
	395
	396	The implementation of our `important` flag will follow this same flow.
142de4	397
969f3f	398	1. Let's implement our feature by first creating a branch. Our new feature, important flag will behave in the same way as the `MARK_TODO_COMPLETED`. Create a new branch in your `todolist-fe` app for our feature and push it to the remote
RS	399
	400	```bash
	401	cd todolist-fe
	402	```
01245c	403	```bash
58480f	404	git checkout -b feature/important-flag
D	405	```
	406	```bash
	407	git push -u origin feature/important-flag
01245c	408	```
d1565e	409
969f3f	410	2. Let's get our tests running by executing a `--watch` on our tests. This will keep re-running our tests everytime there is a file change. It is handy to have this running in a new terminal session.
142de4	411	```bash
58480f	412	npm run test -- --watch
142de4	413	```
D	414
688193	415	> NOTE: You may see an `ENOSPC` error on Linux systems like the following:
RS	416	```bash
	417	ERROR jest exited with code 1.
	418	npm ERR! code ELIFECYCLE
	419	npm ERR! errno 1
	420	npm ERR! todolist-fe@1.0.0 test: `vue-cli-service test "--watch"`
	421	npm ERR! Exit status 1
	422	```
	423	To fix this error, run the following command:
	424	```bash
	425	echo fs.inotify.max_user_watches=524288 \| sudo tee -a /etc/sysctl.conf && sudo sysctl -p
	426	```
	427
1329f3	428	3. All the tests should be passing when we begin. If `No tests found related to files changed since last commit` is on show; hit `a` on the terminal to re-run `all` tests.
969f3f	429
1329f3	430	![rerun-all](../images/exercise3/rerun-all.png)
D	431
969f3f	432	4. There are three places we will add new tests to validate our function behaves as expected against the acceptance criteria from the Feature Story supplied to us. We will need to write tests for our `TodoItem.vue` to handle having a red flag and that it is clickable. Our app is going to need to persist the changes in the backend so we'll want to make changes to our `actions.js` and `mutations.js` to keep the api and local copy of the store in sync. Let's start with our `TodoItem.vue` component. Open the `tests/unit/vue-components/TodoItem.spec.js` file. This has been templated with some example test to correspond with our A/Cs for speed of doing the exercise. Find the describe block for our important flag tests. It is setup already with a `beforeEach()` hook for test setup.
RS	433
142de4	434	![important-flag-before](../images/exercise3/important-flag-before.png)
D	435
969f3f	436	5. Each of our test cases has its skeleton in place already for example the `TodoItem.vue` component takes a property of `todos` when rendering. This setup is already done for each of our tests so all we have to do is fill in our assertions.
RS	437
142de4	438	![todoitem-skeleton-tests](../images/exercise3/todoitem-skeleton-tests.png)
D	439
969f3f	440	6. Let's implement the first test `it("should render a button with important flag"`. This test will assert if the button is present on the page and it contains the `.important-flag` CSS class. To implement this; add the `expect` statement as follows below the `// TODO - test goes here!` comment.
RS	441
142de4	442	```javascript
D	443	it("should render a button with important flag", () => {
	444	const wrapper = mount(TodoItem, {
	445	propsData: { todoItem: importantTodo }
	446	});
	447	// TODO - test goes here!
	448	expect(wrapper.find(".important-flag").exists()).toBe(true);
	449	});
	450	```
	451
969f3f	452	7. Save the file. Observe that the test case has started failing because we have not yet implemented the feature!
RS	453
142de4	454	![todoitem-fail-test](../images/exercise3/todoitem-fail-test.png)
D	455
969f3f	456	8. With a basic assertion in place, let's continue on to the next few tests. We want the important flag to be red when an item in the todolist is marked accordingly. Conversely we want it to be not red when false. Let's create a check for `.red-flag` CSS property to be present when important is true and not when false. Complete the `expect` statements in your test file as shown below for both tests.
RS	457
142de4	458	```javascript
D	459	it("should set the colour to red when true", () => {
	460	const wrapper = mount(TodoItem, {
	461	propsData: { todoItem: importantTodo }
	462	});
	463	// TODO - test goes here!
	464	expect(wrapper.find(".red-flag").exists()).toBe(true);
	465	});
	466	it("should set the colour to not red when false", () => {
	467	importantTodo.important = false;
	468	const wrapper = mount(TodoItem, {
	469	propsData: { todoItem: importantTodo }
	470	});
	471	// TODO - test goes here!
	472	expect(wrapper.find(".red-flag").exists()).toBe(false);
	473	});
	474	```
	475
969f3f	476	9. Finally, we want to make the flag clickable and for it to call a function to update the state. The final test in the `TodoItem.spec.js` we want to create should simulate this behaviour. Implement the `it("call markImportant when clicked", () ` test by first simulating the click of our important-flag and asserting the function `markImportant()` to write is executed.
RS	477
142de4	478	```javascript
4c8a9b	479	it("call markImportant when clicked", () => {
142de4	480	const wrapper = mount(TodoItem, {
D	481	methods,
	482	propsData: { todoItem: importantTodo }
	483	});
	484	// TODO - test goes here!
	485	const input = wrapper.find(".important-flag");
	486	input.trigger("click");
	487	expect(methods.markImportant).toHaveBeenCalled();
	488	});
	489	```
	490
969f3f	491	10. With our tests written for the feature's UI component, let's implement our code to pass the tests. Explore the `src/components/TodoItem.vue`. Each vue file is broken down into 3 sections
RS	492
142de4	493	* The `<template></template>` contains the HTML of our component. This could include references to other Components also
D	494	* The `<script></script>` contains the JavaScript of our component and is essentially the logic for our component. It defines things like `properties`, `methods` and other `components`
	495	* The `<style></style>` contains the encapsulated CSS of our component
1329f3	496
969f3f	497	11. Underneath the `</md-list-item>` tag, let's add a new md-button. Add an `.important-flag` class on the `md-button` and put the svg of the flag provided inside it.
RS	498
142de4	499	```html
D	500	</md-list-item>
867471	501	<!-- TODO - SVG for use in Exercise3 -->
142de4	502	<md-button class="important-flag">
D	503	<svg height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg" ><path d="M0 0h24v24H0z" fill="none"/><path d="M14.4 6L14 4H5v17h2v-7h5.6l.4 2h7V6z"/></svg>
	504	</md-button>
	505	```
	506
969f3f	507	12. We should now see the first of our failing tests has started to pass. Running the app locally (using `npm run serve`) should show the flag appear in the UI. It is clickable but won't fire any events and the colour is not red as per our requirement. Let's continue to implement the colour change for the flag. On our `<svg/>` tag, add some logic to bind the css to the property of a `todo.important` by adding ` :class="{'red-flag': todoItem.important}" `. This logic will apply the CSS class when `todo.important` is true.
RS	508
142de4	509	```html
D	510	<md-button class="important-flag">
	511	<svg :class="{'red-flag': todoItem.important}" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg" ><path d="M0 0h24v24H0z" fill="none"/><path d="M14.4 6L14 4H5v17h2v-7h5.6l.4 2h7V6z"/></svg>
	512	</md-button>
	513	```
	514
969f3f	515	13. More tests should now be passing. Let's wire the click of the flag to an event in Javascript. In the methods section of the `<script></script>` tags in the Vue file, implement the `markImportant()`. We want to wire this to the action to updateTodo, just like we have in the `markCompleted()` call above it. We also need to pass an additional property to this method called `important`
RS	516
142de4	517	```javascript
D	518	markImportant() {
867471	519	// TODO - FILL THIS OUT IN THE EXERCISE
142de4	520	this.$store.dispatch("updateTodo", {id: this.todoItem._id, important: true});
D	521	console.info("INFO - Mark todo as important ", this.todoItem.important);
	522	},
	523	```
	524
969f3f	525	14. Let's connect the click button in the DOM to the Javascript function we've just created. In the template, add a click handler to the md-button to call the function `markImportant()` by adding ` @click="markImportant()"` to the `<md-button>` tag
RS	526
142de4	527	```html
867471	528	<!-- TODO - SVG for use in Exercise3 -->
142de4	529	<md-button class="important-flag" @click="markImportant()">
D	530	<svg :class="{'red-flag': todoItem.important}" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg" ><path d="M0 0h24v24H0z" fill="none"/><path d="M14.4 6L14 4H5v17h2v-7h5.6l.4 2h7V6z"/></svg>
	531	</md-button>
	532	```
9f3a7a	533
969f3f	534	15. Finally - we need to make it so that when a new todo item is created it will have an important property. Head to `store/actions.js` and add `important: false` below `completed: false` in the `addTodo(){}` action.
RS	535
	536	![fe-add-actions-important](../images/exercise3/fe-add-actions-important.jpg)
9f3a7a	537
142de4	538
969f3f	539	16. The previously failing tests should have started to pass now. With this work done, let's commit our code. On the terminal, run
142de4	540	```bash
58480f	541	git add .
D	542	```
	543	```bash
	544	git commit -m "Implementing the todoitem flag"
	545	```
	546	```bash
	547	git push
142de4	548	```
969f3f	549	17. Start our local development server to test the changes
142de4	550
969f3f	551	```bash
RS	552	npm run serve
	553	```
3ee499	554
969f3f	555	18. Open our local todolist app (http://localhost:8080/#/todo). If we try to use our important flag, we should see it's still not behaving as expected; this is because we're not updating the state of the app in response to the click event.
RS	556
	557	19. We need to implement the `actions` and `mutations` for our feature. Let's start with the tests. Open the `tests/unit/javascript/actions.spec.js` and navigate to the bottom of the file. Our action should should commit the `MARK_TODO_IMPORTANT` to the mutations. Scroll to the end of the test file and implement the skeleton test by adding `expect(commit.firstCall.args[0]).toBe("MARK_TODO_IMPORTANT");` as the assertion.
	558
142de4	559	```javascript
D	560	it("should call MARK_TODO_IMPORTANT", done => {
	561	const commit = sinon.spy();
	562	state.todos = todos;
	563	actions.updateTodo({ commit, state }, { id: 1, important: true }).then(() => {
	564	// TODO - test goes here!
	565	expect(commit.firstCall.args[0]).toBe("MARK_TODO_IMPORTANT");
	566	done();
	567	});
	568	});
	569	```
	570
969f3f	571	20. We should now have more failing tests, let's fix this by adding the call from our action to the mutation method. Open the `src/store/actions.js` file and scroll to the bottom to the `updateTodo()` method. Complete the if block by adding `commit("MARK_TODO_IMPORTANT", i);` as shown below.
RS	572
142de4	573	```javascript
D	574	updateTodo({ commit, state }, { id, important }) {
	575	let i = state.todos.findIndex(todo => todo._id === id);
	576	if (important) {
9f3a7a	577	// TODO - add commit important here!
142de4	578	commit("MARK_TODO_IMPORTANT", i);
D	579	} else {
	580	commit("MARK_TODO_COMPLETED", i);
	581	}
	582	```
	583
969f3f	584	21. Finally, let's implement the `mutation` for our feature. Again, starting with the tests... Open the `tests/unit/javascript/mutations.spec.js` to find our skeleton tests at the bottom of the file. Our mutation method is responsible for toggling the todo's `important` property between `true` and `false`. Let's implement the tests for this functionality by setting important to be true and calling the method expecting the inverse. Then let's set it to false and call the method expecting the inverse. Add the expectations below the `// TODO - test goes here!` comment as done previously.
RS	585
142de4	586	```javascript
D	587	it("it should MARK_TODO_IMPORTANT as false", () => {
	588	state.todos = importantTodos;
	589	// TODO - test goes here!
	590	mutations.MARK_TODO_IMPORTANT(state, 0);
	591	expect(state.todos[0].important).toBe(false);
	592	});
	593
	594	it("it should MARK_TODO_IMPORTANT as true", () => {
	595	state.todos = importantTodos;
	596	// TODO - test goes here!
	597	state.todos[0].important = false;
	598	mutations.MARK_TODO_IMPORTANT(state, 0);
	599	expect(state.todos[0].important).toBe(true);
	600	});
	601	```
	602
969f3f	603	22. With our tests running and failing, let's implement the feature to their spec. Open the `src/store/mutations.js` and add another function called `MARK_TODO_IMPORTANT` below the `MARK_TODO_COMPLETED` to toggle `todo.important` between true and false. NOTE - add a `,` at the end of the `MARK_TODO_COMPLETED(){}` function call.
RS	604
142de4	605	```javascript
D	606	MARK_TODO_IMPORTANT(state, index) {
	607	console.log("INFO - MARK_TODO_IMPORTANT");
	608	state.todos[index].important = !state.todos[index].important;
	609	}
	610	```
969f3f	611
3ee499	612	![mark-todo-important](../images/exercise3/mark-todo-important.png)
142de4	613
969f3f	614	23. All our tests should now be passing. On the watch tab where they are running, hit `a` to re-run all tests and update any snapshots with `u` if needed.
142de4	615
969f3f	616	24. With all our tests now passing, let's commit our code. On the terminal, run
RS	617
142de4	618	```bash
58480f	619	git add .
D	620	```
	621	```bash
	622	git commit -m "Implementing the store and actions"
	623	```
	624	```bash
	625	git push
142de4	626	```
D	627
969f3f	628	25. Before running a build in Jenkins, let's add our tests and code to the develop branch. Ask your neighbour to review your code changes and if they approve; merge them to Develop! (If you're feeling adventurous - raise a PR through GitLab and have someone on your desk peer review it!)
RS	629
	630	<!-- <p class="tip">
142de4	631	NOTE - At this point in a residency we would peer review the code before pushing it to develop or master branch!
969f3f	632	</p> -->
RS	633
142de4	634	```bash
58480f	635	git checkout develop
D	636	```
	637	```bash
	638	git merge feature/important-flag
	639	```
	640	```bash
	641	git push --all
142de4	642	```
D	643
969f3f	644	26. Run a build in Jenkins. If all things were successful; our application should be deployed as expected! Validate the flag is working as expected. Invoke the route URL for the application from the `*-dev` namespace in the OCP web console.
RS	645
3ee499	646	![todolist-important](../images/exercise3/todolist-important.png)
d1565e	647
752f2a	648	#### 2c - Create todolist e2e tests
d1565e	649
cf760d	650	> Using [Nightwatch.js](http://nightwatchjs.org/) We will write a reasonably simple e2e test to test the functionality of the feature we just implemented.
d6eb80	651
969f3f	652	1. Firstly we need to create an e2e spec test file in the correct place.
d6eb80	653
T	654	```bash
	655	touch tests/e2e/specs/importantFlag.js
	656	```
	657
969f3f	658	> NOTE: Windows users should create this new file using a text editor.
RS	659
	660	2. Open this new file in your code editor and set out the initial blank template for an e2e test as below:
	661
d6eb80	662	![if-e2e-step1](../images/exercise3/if-e2e-step1.png)
T	663
	664	3. Now get the test to access the todos page and wait for it to load. The url can be taken from `process.env.VUE_DEV_SERVER_URL`
969f3f	665
d6eb80	666	![if-e2e-step2](../images/exercise3/if-e2e-step2.png)
T	667
969f3f	668	4. Write code to do the following:
RS	669	* Click the clear all button and then enter a value in the textbox to create a new item.
	670	* Assert that an 'important flag' exists (the button to set important)
	671	* Assert that a red flag does not exist.
	672	* Click the important flag and check whether the flag has turned red.
	673
	674	5. You will need to reference the clear all button from the test code. We will therefore have to go to `src/components/XofYItems.vue` and add `id="clear-all"` to the clear all button.
	675
	676	<!-- ![if-e2e-step3](../images/exercise3/if-e2e-step3.png) -->
d6eb80	677	![if-e2e-step3a](../images/exercise3/if-e2e-step3a.png)
T	678
969f3f	679	6. Write the following test code. The pauses allow for the body of the page to render the todo list before exercising the test code:
d6eb80	680
969f3f	681	<!-- ![if-e2e-step4](../images/exercise3/if-e2e-step4.png) -->
RS	682	![if-e2e-step4](../images/exercise3/e2e-code-listing-full.jpg)
	683
	684	7. At this point we should have a working e2e test. We can run this by using `npm run e2e`. When all tests pass, we can push up these changes.
d6eb80	685
T	686	```bash
	687	git add .
	688	```
	689
	690	```bash
	691	git commit -m "Implementing e2e tests"
	692	```
	693
	694	```bash
	695	git push
	696	```
5a16fd	697
01245c	698	---
5a16fd	699
969f3f	700	<!-- ## Extension Tasks
01245c	701
5a16fd	702	> _Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution and are provided for additional scope._
D	703
cad21a	704	* Add Config maps to inject DB creds to the app
D	705	* Create a blue/green deploy based on the success of running e2e tests against either blue or green and flopping load over to new endpoint when successful.
	706	Advanced
	707	* Add Auth0 support to your FE app.
5a16fd	708
D	709	## Additional Reading
01245c	710
5a16fd	711	> List of links or other reading that might be of use / reference for the exercise
D	712
	713	## Slide links
01245c	714
4f0295	715	- [Intro](https://docs.google.com/presentation/d/18W0GoBTwRGpgbOyHf2ZnL_OIWU_DvsoR14H0_t5jisA)
RH	716	- [Wrap-up](https://docs.google.com/presentation/d/1uIYHC57POSaVD6XNZGhdetABiSnlP1TztYTgglMP-DA)
969f3f	717	- [All Material](https://drive.google.com/drive/folders/1xVaQukmwwmyJSDN0zOkghZX7yb-0freT) -->