view | history | commit | commitdiff
Donal Spring
2018-04-18 7ffc3b0f9c475e1b69fdc4640d09d067fa494b72
commit | author | age
92e460 1 # Revenge Of The Automated Testing
43f2f2 2
5285f8 3 > The purpose of this lab is to develop and validate a new feature using TDD; and to promote the assured feature through the pipeline.
f6d2bd 4
62a054 5 ![comic-header](../images/exercise3/comic-header.png)
RH 6
7 [Image Source](https://cdn-images-1.medium.com/max/1600/1*wF_fSCH-gLYfMbkwb3gR2w.png)
8
b76e74 9 ## Introduction to TDD.
D 10
11 > _Here is a brief introduction of TDD and why we use it._
12
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
15 The TDD cycle can be illustrated with the following diagram;
16 ![TDD-diagram](../images/exercise3/TDD-lifecycle.jpg)
17
18 ### The TDD Cycle 
19
20 1. `Write a test` -
21 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 features specification and requirements, or the feature could be wrong from the get-go. 
22
23 2. `Test Fails` -
24 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. 
25
26 3. `Write code to make test pass` -
27 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.
28
29 4. `Code Passes tests` -
30 If all tests pass, the developer can be confident that the new code meets the test requirements.
31
32 5. `Refactor` -
33 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.
34
35 6. `Repeat` -
36 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.
37
38 ### Testing Bananalogy
39 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.
40 ![bdd-bananas](../images/exercise3/bdd-bananas.png)
41   * `describe` is used to group tests together. The string `"a bunch of ripe bananas"` is for human reading and allows you to identify tests.
42   * `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.
43
f6d2bd 44 ---
43f2f2 45
D 46 ## Learning Outcomes
f6d2bd 47
43f2f2 48 As a learner you will be able to
f6d2bd 49
5285f8 50 * Understand the why behind TDD
D 51 * Implement a feature using TDD for frontend and backend
52 * Write end to end tests for the feature and run them in CI
43f2f2 53
D 54 ## Tools and Frameworks
f6d2bd 55
43f2f2 56 > Name of tool - short description and link to docs or website
D 57
5285f8 58 1.  [Jest](https://facebook.github.io/jest/) - Zero configuration testing platform
D 59 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.
60 1.  [Vue Test Utils](https://vue-test-utils.vuejs.org/en/) - Vue Test Utils is the official unit testing utility library for Vue.js.
61 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.
62 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.
63 1.  [Sinon](http://sinonjs.org/) - Standalone test spies, stubs and mocks for JavaScript. 
64 Works with any unit testing framework.
43f2f2 65
D 66 ## Big Picture
f6d2bd 67
43f2f2 68 This exercise begins cluster containing blah blah
D 69
f6d2bd 70 ---
43f2f2 71
D 72 ## 10,000 Ft View
73
5285f8 74 > The goal of this exercise is to add a new component to the application using TDD to create and validate it's behaviour. The User story we have been given is as follows:
43f2f2 75
5285f8 76 *As a doer I want to mark todos as important so that I can keep track of and complete high prirority todos first*
f6d2bd 77
5285f8 78 _Acceptance Criteria_
D 79 - [ ] should be doable with a single click
80 - [ ] should add a red flag against the todo when marked important
81 - [ ] should remove the red colour flag on the flag when important removed
82 - [ ] should not affect existing todos
83
84 _On page load:_
85 - [ ] should display existing todos that are not marked important
86 - [ ] should display existing todos that are marked important with an red flag
43f2f2 87
D 88 ## Step by Step Instructions
91cc51 89 > This is a fairly structured guide with references to exact filenames and sections of text to be added.
43f2f2 90
f6d2bd 91 ### Part 1 - Tests in our Pipeline
b76e74 92 > _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 frontend & backend along with some end to end tests (e2e) to validate the full solution_
43f2f2 93
bc2216 94 #### Part 1a - Unit tests
bc975e 95 > In this exercise we will execute our test for the frontend and backend locally. Once verified we will add them to Jenkins.
bc2216 96
bc975e 97 2. 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`.
91cc51 98 ```bash
A 99 $ cd todolist-fe
100 $ npm run test
101 ```
102 <p class="tip" > 
60bca4 103 `test` is an alias used that runs `vue-cli-service test` from the scripts object in `package.json`
91cc51 104 </p>
b76e74 105 ![screenshot-scripts](../images/exercise3/screenshot-scripts.png)
D 106
107 2. This command will run all `*spec.js` files. Our test files are stored in the following places. There are 12 Frontend test files stored in these directories: `todolist-fe/tests/unit/vue-components/*` & `todolist-fe/tests/unit/javascript/*`
bc2216 108
91cc51 109 2. 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.
b76e74 110 ![test-run-locally](../images/exercise3/test-run-locally.png)
91cc51 111
b76e74 112 2. Repeat the same process for `todolist-api` and verify that all the tests run. There are 2 Api test files: `todolist-api/server/api/todo/todo.spec.js` & `todolist-api/server/mocks/mock-routes.spec.js`
91cc51 113 ```bash
A 114 $ cd todolist-api
115 $ npm run test
116 ```
6e5072 117
a52ae2 118 2. Navigate to your instance of jenkins at `https://jenkins-<YOUR_NAME>-ci-cd.apps.somedomain.com/`. 
91cc51 119 Click on `dev-todolist-fe-build` and then click the `configure` button on the left-hand side.
b76e74 120 ![jenkins-configure-job](../images/exercise3/jenkins-configure-job.png)
91cc51 121
A 122 2. Scroll to the `Build` part of the configuration page and add `scl enable rh-nodejs8 'npm run test'` below `scl enable rh-nodejs8 'npm install'`. Click `save` or `apply` at the bottom to save the changes.
b76e74 123 ![jenkins-build-step](../images/exercise3/jenkins-build-step.png)
91cc51 124
60bca4 125 2. Scroll to the `Post-build Actions` section and click `Add post-build action`. Select `Publish xUnit test result report`.
b76e74 126 ![xunit-action](../images/exercise3/xunit-action.png)
6e5072 127
A 128 2. 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:
b76e74 129 ![post-build-actions](../images/exercise3/post-build-actions.png)
6e5072 130
f56999 131 2. Click `save` or `apply` 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.
6e5072 132
A 133 2. We're now going to deliberately fail a test to ensure that `bake` and `deploy` jobs aren't triggered if any tests fail. Go to `ListOfTodos.spec.js` in `/tests/unit/vue-components` and head to `line 38`. Add `not.` before `toHaveBeenCalled()`.
b76e74 134 ![change-test-to-fail](../images/exercise3/change-test-to-fail.png)
6e5072 135
f56999 136 2. Push this to Gitlab and run the build job.
6e5072 137 ```bash
A 138 $ git add .
139 $ git commit -m "Deliberately failed test to test the pipeline stops me deploying broken code"
140 $ git push
141 ```
142
143 2. Rerun the `dev-todolist-fe-build` job. It should have failed and not run any other builds. 
b76e74 144 ![jenkins-with-failing-build](../images/exercise3/jenkins-with-failing-build.png)
6e5072 145
2717b2 146 2. Undo the changes you made to the `ListOfTodos.spec.js` file, commit your code and rerun the build. This should trigger a full `build --> bake --> deploy` of `todolist-fe`.
A 147
148 2. We're now going to do the same for the api. Head to the `configure` panel of the `dev-todolist-api-build` job. 
149
150 2. Add `scl enable rh-nodejs8 'npm run test:ci'` above `npm run build:ci`.
b76e74 151 ![api-build-step](../images/exercise3/api-build-step.png)
2717b2 152
4f979b 153 2. Scroll to the `Post-build Actions` section and click `Add post-build action`. Select `Publish xUnit test result report`.
2717b2 154
A 155 2. Click the `Add` button under `Publish xUnit test result report` and select `JUnit`. In the pattern field enter `reports/server/mocha/test-results.xml`. In the `Failed Tests Thresholds`  input box enter 0 under `Red Ball Total`. It should look a little something like this:
b76e74 156 ![api-post-build](../images/exercise3/api-post-build.png)
2717b2 157
A 158 2. We're now going to deliberately fail a test again to ensure that `bake` and `deploy` jobs aren't triggered if any tests fail. Go to `todo.spec.js` in `/server/api/todo` and head to `line 35`. Replace `false` with `true`. 
b76e74 159 ![api-fail-build](../images/exercise3/api-fail-build.png)
2717b2 160
f56999 161 2. Push this to Gitlab and run the build job.
2717b2 162 ```bash
A 163 $ git add .
164 $ git commit -m "Deliberately failed test to test the pipeline stops me deploying broken code"
165 $ git push
166 ```
167
f56999 168 2. If successful this will fail the build and not run the `bake` or `deploy` jobs. 
A 169
170 <p class="tip">
171   NOTE - Don't forget to undo the changes that you made to your tests!
172 </p>
2717b2 173
bc2216 174 #### Part 1b - End to End tests (e2e)
4f979b 175 > TODO - this section is not complete
bc2216 176
f6d2bd 177 2.  Add new part to the dev pipeline (`dev-todolist-fe-e2e`)
bc2216 178
4f979b 179 2. Add e2e tests and reporting to Jenkins
bc2216 180
5285f8 181 ### Part 2 - TodoList new feature
bc2216 182 > _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 183
5285f8 184 *As a doer I want to mark todos as important so that I can keep track of and complete high prirority todos first*
bc2216 185
5285f8 186 _Acceptance Criteria_
D 187 - [ ] should be doable with a single click
188 - [ ] should add a red flag against the todo when marked important
189 - [ ] should remove the red colour flag on the flag when important removed
190 - [ ] should not affect existing todos
bc2216 191
5285f8 192 _On page load:_
D 193 - [ ] should display existing todos that are not marked important
194 - [ ] should display existing todos that are marked important with an red flag
bc2216 195
f6d2bd 196 #### Part 1a - Create todolist-api tests
5285f8 197 > 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.
f6d2bd 198
D 199 3.  Create a new branch in your `todolist-api` app for our feature and push it to the remote
bc2216 200 ```bash
D 201 $ git checkout -b feature/important-flag
202 $ git push -u origin feature/important-flag
43f2f2 203 ```
D 204
f6d2bd 205 3.  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.
D 206 ```javascript
207 describe("GET /api/todos", function() {
208     it("should respond with JSON array", function(done) {
209         request(app)
210         .get("/api/todos")
211         .expect(200)
212         .expect("Content-Type", /json/)
213         .end(function(err, res) {
214             if (err) return done(err);
215             // Test goes here
216             res.body.should.be.instanceof(Array);
217             done();
218         });
5285f8 219       });
f6d2bd 220 });
D 221 ```
222 where:
5285f8 223 _ `describe` is used to group tests together into a collection asserting some feature; for example the get all todos api.
D 224 _ `it` is an individual test statement and should contain an `expect` or a `should` statement asserting behaviour of the API under test.
225 _ `request` is a library for making http calls to the api.
226 _ `.expect(200)` asserts the HTTP Return Code
227 _ `res.body.should.be.instanceof(Array);` is the actual test call
228 _ `done();` tells the test runner that `mocha` has finished execution. This is needed as the http calls are asynchronous.
43f2f2 229
5285f8 230 3.  With this knowledge; let's implement our test for the `important` flag. We expect the fronted 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 test which should be at the bottom ![todo-api-tests](../images/exercise3/todo-api-tests.png).
f6d2bd 231
5285f8 232 3.  Before writing our test; let's first make sure all the existing tests are passing.
D 233 ```bash
f6d2bd 234 $ npm run test
D 235 ```
236
5285f8 237 3.  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. A PUT request responds in our API with the data that it just updated, so provided that MongoDB accepted the change, it will respond with an object that has the `important` property on it. To write our test; edit the `it("should ....", function(done) {` by completing the following:
f6d2bd 238     * Edit the `it("should ...")` to describe the imporant flag we're testing
D 239     * Edit the `.send()` to include `important: true` property
240     * Add a new test assertion to check that `res.body.important` is `true` below the `// YOUR TEST GO HERE` line.
241 ```javascript
5285f8 242 it("should mark todo as important and persist it", function(done) {
f6d2bd 243     request(app)
D 244       .put("/api/todos/" + todoId)
5285f8 245       .send({
D 246         title: "LOVE endpoint/server side testing!",
247         completed: true,
248         important: true
249       })
f6d2bd 250       .expect(200)
D 251       .expect("Content-Type", /json/)
252       .end(function(err, res) {
5285f8 253           if (err) return done(err);
D 254           res.body.should.have.property("_id");
255           res.body.title.should.equal("LOVE endpoint/server side testing!");
256           // YOUR TEST GO HERE
257           res.body.important.should.equal(true);
258           done();
f6d2bd 259       });
5285f8 260 });
f6d2bd 261 ```
D 262
5285f8 263 3.  Run your test. It should fail.
D 264 ```bash
f6d2bd 265 $ npm run test
D 266 ```
267 ![fail-mocha](../images/exercise3/fail-mocha.png)
268
5285f8 269 3.  With our test now failing; let's implement the feature. This is quite a simple change; all we need to do it update the `server/api/todo/todo.model.js` to allow an additional property on the schema called `important` of type Boolean.
f6d2bd 270 ```javascript
D 271 const TodoSchema = new Schema({
5285f8 272   title: String,
D 273   completed: Boolean,
274   important: Boolean
f6d2bd 275 });
D 276 ```
277
5285f8 278 3.  With your changes to the Database schema updated; re-run your tests.
D 279 ```bash
f6d2bd 280 $ npm run test
D 281 ```
282
5285f8 283 3.  Commit your code to the `feature/important-flag` branch and then merge onto the `develop` branch as follows
f6d2bd 284 <p class="tip">
D 285 NOTE - At this point in a residency we would peer review the code before pushing it to develop or master branch!
286 </p>
5285f8 287 ```bash
f6d2bd 288 $ git add .
D 289 $ git commit -m "ADD backend schema updates"
290 $ git checkout develop
291 $ git merge feature/important-flag
292 $ git push --all
293 ```
294
295 #### Part 1b - Create todolist-fe tests
5285f8 296 > 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 fronted 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. 
f6d2bd 297
5285f8 298 Our TodoList App uses `vuex` to manage the state of the apps' 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. 
f6d2bd 299
5285f8 300 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 it's own way of updating the store. It is bad practice to call the store directly. 
D 301
302 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 apps local store for rendering in the view.
303
304 For example; when marking a todo as done in the UI, the following flow occurs
305     * The `TodoItem.vue` calls the `markTodoDone()` function which dispatches an event to the store.
306     * This calls the `updateTodo()` function in the `actions.js` file
307     * The action will update the backend db (calling our `todolist-api`) with our updated todo object.
308     * The action will commit the change to the store by calling the mutation method `MARK_TODO_COMPLETED`
309     * The `MARK_TODO_COMPLETED` will directly access the store object and update it with the new state value
310     * The `ListOfTodos.vue` component is watching the store for changes and when something gets updated it re-renders the `TodoItem.vue`.
311
312 3. 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
f6d2bd 313 ```bash
D 314 $ git checkout -b feature/important-flag
315 $ git push -u origin feature/important-flag
316 ```
bc2216 317
5285f8 318 3. 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. All the tests should be passing when we begin
D 319 ```bash
320 $ npm run test -- --watch
321 ```
322
bc581a 323 3. There are three places we will add new tests to validate our function behaves as expected against the acceptance criteria from 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 lab. Find the describe block for our important flag tests. It is setup already with a `beforeEach()` hook for test setup.
5285f8 324 ![important-flag-before](../images/exercise3/important-flag-before.png)
D 325
326 3. Each of our test cases has it's 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.
327 ![todoitem-skeleton-tests](../images/exercise3/todoitem-skeleton-tests.png)
328
329 3. 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.  
330 ```javascript
331   it("should render a button with important flag", () => {
332     const wrapper = mount(TodoItem, {
333       propsData: { todoItem: importantTodo }
334     });
335     // TODO - test goes here!
336     expect(wrapper.find(".important-flag").exists()).toBe(true);
337   });
338 ```
339
340 3. Save the file and we should see in our test watch the test case has started failing because we have not yet implemented the feature!
341 ![todoitem-fail-test](../images/exercise3/todoitem-fail-test.png)
342
343 3. 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 imporant is true and not when false.
344 ```javascript
345   it("should set the colour to red when true", () => {
346     const wrapper = mount(TodoItem, {
347       propsData: { todoItem: importantTodo }
348     });
349     // TODO - test goes here!
350     expect(wrapper.find(".red-flag").exists()).toBe(true);
351   });
352   it("should set the colour to not red when false", () => {
353     importantTodo.important = false;
354     const wrapper = mount(TodoItem, {
355       propsData: { todoItem: importantTodo }
356     });
357     // TODO - test goes here!
358     expect(wrapper.find(".red-flag").exists()).toBe(false);
359   });
360 ```
361
bc581a 362 3. 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 makImportant when clicked", () ` test by first simulating the click of our important-flag and asserting the function `markImportant()` to write is executed.
5285f8 363 ```javascript
D 364   it("call makImportant when clicked", () => {
365     const wrapper = mount(TodoItem, {
366       methods,
367       propsData: { todoItem: importantTodo }
368     });
369     // TODO - test goes here!
370     const input = wrapper.find(".important-flag");
371     input.trigger("click");
372     expect(methods.markImportant).toHaveBeenCalled();
373   });
374 ```
375
376 3. With our tests written for the feature's UI component, let's implement our code to pass the tests. Open up the `src/components/TodoItem.vue`. Each vue file is broken down into 3 sections
377     * The `<template></template>` contains the HTML of our component. This could include references to other Components also
378     * 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`
379     * The `<style></style>` contains the encapsulated CSS of our component
380 Underneath the `</md-list-item>` tag, let's add a new md-button. Add a `.important-flag` class on the `md-button` and put the svg of the flag provided inside it.
381 ```html
382     </md-list-item>
383     <!-- TODO - SVG for use in Lab3 -->
384     <md-button class="important-flag">
385         <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>
386     </md-button>
387 ```
388
389 3. 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.
390 ```html
391 <md-button class="important-flag">
392     <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>
393 </md-button>
394 ```
395
396 3. 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 and additional property to this method call `imporant`
397 ```javascript
398     markImportant() {
399       // TODO - FILL THIS OUT IN THE LAB EXERCISE
400       this.$store.dispatch("updateTodo", {id: this.todoItem._id, important: true});
401       console.info("INFO - Mark todo as important ", this.todoItem.important);
402     },
403 ```
404
405 3. Finally - 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 
406 ```html
407     <!-- TODO - SVG for use in Lab3 -->
408     <md-button class="important-flag" @click="markImportant()">
409         <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>
410     </md-button>
411 ```
412
413 3. The previously failing tests should have started to pass now. With this work done, let's commit our code. On the terminal, run 
414 ```bash
415 $ git add .
416 $ git commit -m "Implementing the todoitem flag"
417 $ git push
418 ```
419
bc581a 420 3. 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. 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.
5285f8 421 ```javascript
D 422   it("should call MARK_TODO_IMPORTANT", done => {
423     const commit = sinon.spy();
424     state.todos = todos;
425     actions.updateTodo({ commit, state }, { id: 1, important: true }).then(() => {
426         // TODO - test goes here!
427         expect(commit.firstCall.args[0]).toBe("MARK_TODO_IMPORTANT");
428         done();
429     });
430   });
431 ```
432
bc581a 433 3. 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.
5285f8 434 ```javascript
D 435 updateTodo({ commit, state }, { id, important }) {
436     let i = state.todos.findIndex(todo => todo._id === id);
437     if (important) {
438         // TODO - add commit imporant here!
439         commit("MARK_TODO_IMPORTANT", i);
440     } else {
441         commit("MARK_TODO_COMPLETED", i);
442     }
443 ```
444
445 3. Finally, let's implement the `mutation` for our feature. Again, starting with the tests..... Open the `tests/unit/javascript/mutations.spec.js`. Our mutation method is responsible to toggling the todo's `important` property between true and 
446 false. Let's implement the tests for this functionality by setting imporant to be true and calling the method expecting the inverse and setting it to false and calling the method expecting the inverse. 
447 ```javascript
448   it("it should MARK_TODO_IMPORTANT as false", () => {
449     state.todos = importantTodos;
450     // TODO - test goes here!
451     mutations.MARK_TODO_IMPORTANT(state, 0);
452     expect(state.todos[0].important).toBe(false);
453   });
454
455   it("it should MARK_TODO_IMPORTANT as true", () => {
456     state.todos = importantTodos;
457     // TODO - test goes here!
458     state.todos[0].important = false;
459     mutations.MARK_TODO_IMPORTANT(state, 0);
460     expect(state.todos[0].important).toBe(true);
461   });
462 ```
463
464 3. 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.
465 ```javascript
466   MARK_TODO_IMPORTANT(state, index) {
467     console.log("INFO - MARK_TODO_IMPORTANT");
468     state.todos[index].important = !state.todos[index].important;
469   }
470 ```
471
472 3. All our tests should now be passing. On the watch tab where they are running, hit `u` to re-run all tests and update any snapshots.
473
474 3. With all our tests now passing, let's commit our code. On the terminal, run
475 ```bash
476 $ git add .
477 $ git commit -m "Implementing the store and actions"
478 $ git push
479 ```
480
481 3. Before running a build in Jenkins, let's add our tests and code to the develop branch
482 <p class="tip">
483 NOTE - At this point in a residency we would peer review the code before pushing it to develop or master branch!
484 </p>
485 ```bash
486 $ git checkout develop
487 $ git merge feature/important-flag
488 $ git push --all
489 ```
490
491 3. Run a build in Jenkins. We should see the test trend increase as we've added more tests. Validate the flag is working as expected.
bc2216 492
D 493 #### Part 1c - Create todolist e2e tests
494
5285f8 495 3.  TODO !!
43f2f2 496
f6d2bd 497 ---
43f2f2 498
D 499 ## Extension Tasks
f6d2bd 500
43f2f2 501 > _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 502
f6d2bd 503 * Add Auth to your application
D 504 * Do some other stuff
43f2f2 505
D 506 ## Additional Reading
f6d2bd 507
43f2f2 508 > List of links or other reading that might be of use / reference for the exercise
D 509
510 ## Slide links
f6d2bd 511
D 512 > link back to the deck for the supporting material