Дз «Тесты» — Шилов Максим

.eslintrc.json

@@ -0,0 +1,34 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es6": true,
+        "jquery": true
+    },
+    "rules": {
+        "no-unused-vars": [
+            0,
+            {
+                "vars": "all",
+                "args": "after-used"
+            }
+        ],
+        "func-names": [
+            "error",
+            "never"
+        ],
+        "no-console": "off",
+        "no-unused-expressions": [
+            2,
+            {
+                "allowShortCircuit": true,
+                "allowTernary": true
+            }
+        ],
+        "no-undef": "off",
+        "no-plusplus": "off",
+        "consistent-return": "off",
+        "no-underscore-dangle": "off"
+    },
+    "extends": "airbnb-base"
+}

.gitignore

@@ -1 +1,6 @@
-node_modules
+node_modules
+/.idea/
+*.DS_Store
+.nyc_output
+coverage
+hermione/screens

.hermione.conf.js

@@ -0,0 +1,28 @@
+module.exports = {
+  baseUrl: 'http://localhost:3000/',
+  // gridUrl: 'http://0.0.0.0:4444/wb/hub',
+  compositeImage: true,
+  sets: {
+    desktop: {
+      files: 'hermione/*.hermione.js'
+    }
+  },
+  browsers: {
+    chrome: {
+      desiredCapabilities: {
+        browserName: 'chrome'
+      }
+    },
+    firefox: {
+      desiredCapabilities: {
+        browserName: 'firefox'
+      }
+    },
+  },
+  plugins: {
+    'html-reporter/hermione': {
+      path: 'hermione-html-reporter',
+    },
+    'hermione-custom-commands': true,
+  },
+};

README.md

@@ -1,5 +1,57 @@
 # Домашнее задание: автотесты
+##Запуск
+```
+npm i
+npm start
+```
+Запуск модульных тестов
+```
+npm run unit-tests
+```
+Запуск интеграционных тестов
+```
+npm run start-selenium
+npm run integration-tests
+```
+##Модульные тесты
+* Перед созданимем модульных тестов был произведен рефакторинг файлов git.js и navigation.js — функции были заменены на методы класса, в экспорт передается экземпляр класса и класс для тестов.
+* В качестве логических блоков для модульных тестов были взяты:
+  * Обработка приходящих данных
+     * Получение истории коммитов — метод возвращает массив
+     * Получение списка файлов коммита — метод принимает хеш коммита и путь, возвращает массив файлов
+     * Преобразование строки в объект данных — метод принимает строку из истории коммитов, возвращает объект
+  * Формирование url навигации.
+     * Формирование url для файлов коммита — метод принимает хеш, возвращает url для текущего коммита
+     * Формирование url для директорий и файлов коммита — метод принимает хеш и директории коммита, обрабатывает исключения и возвращает url 
+     * Формирование хлебных крошек — метод принимает хеш и путь, обрабатывает исключения, возвращает массив хлебных крошек
+
+Тесты:
+* tests/utils/git.test.js
+* tests/utils/navigations.test.js
+
+ Для метода executeGit была написана заглушка (stub), т.к. он ссылается на внешнюю зависимость execFile. Метод gitFileContent не был протестирован т.к. он обращается на прямую к методу executeGit без каких-либо преобразований данных.
+
+ Для анализа покрытия тестами был использован istanbul
+
+## Интеграционные тесты
+* hermione/breadcrumbs.hermione.js
+* hermione/layout.hermione.js
+* hermione/screenshot.hermione.js
+* hermione/url.hermione.js
+
+Интеграционные тесты осуществляют тестирование:
+* Вывод основных блоков (layout.hermione.js)
+* Правильное отображение выводимых блоков (screenshot.hermione.js)
+* Корректная работа хлебных крошек (breadcrumbs.hermione.js)
+* Формирование и работа перехода по страницам (url.hermione.js)
+
+Были написано 2 кастомные команды для Гермионы:
+* assertExists — проверяет наличие селектора на странице
+* assertUrl — проверяет соответствие текущего url с заданным
+
+В .hermione.conf.js закомментировал gridUrl: 'http://0.0.0.0:4444/wb/hub', с ним почему-то сыпались ошибки 
 
+---
 Вам дано приложение на JavaScript и нужно написать для него автотесты: интеграционные тесты на интерфейс и модульные тесты на серверную часть.
 
 ## Предметная область

app.js

@@ -25,14 +25,14 @@ app.get('/files/:hash/*?', filesController);
 app.get('/content/:hash/*?', contentController);
 
 // error handlers
-app.use(function(req, res, next) {
-  var err = new Error('Not Found');
+app.use((req, res, next) => {
+  const err = new Error('Not Found');
   err.status = 404;
   next(err);
 });
 
 // error handler
-app.use(function(err, req, res, next) {
+app.use((err, req, res, next) => {
   const { status = 500, message } = err;
 
   // render the error page

controllers/contentController.js

@@ -1,28 +1,29 @@
-const { gitFileContent, gitFileTree } = require('../utils/git');
-const { buildFolderUrl, buildBreadcrumbs } = require('../utils/navigation');
+const { git } = require('../utils/git');
+const { navigation } = require('../utils/navigation');
 
-module.exports = function(req, res, next) {
+module.exports = function (req, res, next) {
   const { hash } = req.params;
-  const path = req.params[0].split('/').filter(Boolean);
+  const path = req.params[0].split('/')
+    .filter(Boolean);
 
-  gitFileTree(hash, path.join('/'))
-    .then(function([file]) {
+  git.gitFileTree(hash, path.join('/'))
+    .then(([file]) => {
       if (file && file.type === 'blob') {
-        return gitFileContent(file.hash);
+        return git.gitFileContent(file.hash);
       }
     })
     .then(
-      content => {
+      (content) => {
         if (content) {
           res.render('content', {
             title: 'content',
-            breadcrumbs: buildBreadcrumbs(hash, path.join('/')),
-            content
+            breadcrumbs: navigation.buildBreadcrumbs(hash, path.join('/')),
+            content,
           });
         } else {
           next();
         }
       },
-      err => next(err)
+      err => next(err),
     );
 };

controllers/filesController.js

@@ -1,41 +1,37 @@
-const { gitFileTree } = require('../utils/git');
-const {
-  buildFolderUrl,
-  buildFileUrl,
-  buildBreadcrumbs
-} = require('../utils/navigation');
+const { git } = require('../utils/git');
+const { navigation } = require('../utils/navigation');
 
 function buildObjectUrl(parentHash, { path, type }) {
   switch (type) {
     case 'tree':
-      return buildFolderUrl(parentHash, path);
+      return navigation.buildFolderUrl(parentHash, path);
     case 'blob':
-      return buildFileUrl(parentHash, path);
+      return navigation.buildFileUrl(parentHash, path);
     default:
       return '#';
   }
 }
 
-module.exports = function(req, res, next) {
+module.exports = function (req, res, next) {
   const { hash } = req.params;
   const pathParam = (req.params[0] || '').split('/').filter(Boolean);
 
-  const path = pathParam.length ? pathParam.join('/') + '/' : '';
+  const path = pathParam.length ? `${pathParam.join('/')}/` : '';
 
-  return gitFileTree(hash, path).then(
-    list => {
+  return git.gitFileTree(hash, path).then(
+    (list) => {
       const files = list.map(item => ({
         ...item,
         href: buildObjectUrl(hash, item),
-        name: item.path.split('/').pop()
+        name: item.path.split('/').pop(),
       }));
 
       res.render('files', {
         title: 'files',
-        breadcrumbs: buildBreadcrumbs(hash, pathParam.join('/')),
-        files
+        breadcrumbs: navigation.buildBreadcrumbs(hash, pathParam.join('/')),
+        files,
       });
     },
-    err => next(err)
+    err => next(err),
   );
 };

controllers/indexController.js

@@ -1,20 +1,20 @@
-const { gitHistory } = require('../utils/git');
-const { buildFolderUrl, buildBreadcrumbs } = require('../utils/navigation');
+const { git } = require('../utils/git');
+const { navigation } = require('../utils/navigation');
 
-module.exports = function(req, res) {
-  gitHistory(1, 20).then(
-    history => {
+module.exports = function (req, res) {
+  git.gitHistory(1, 20).then(
+    (history) => {
       const list = history.map(item => ({
         ...item,
-        href: buildFolderUrl(item.hash, '')
+        href: navigation.buildFolderUrl(item.hash, ''),
       }));
 
       res.render('index', {
         title: 'history',
-        breadcrumbs: buildBreadcrumbs(),
-        list
+        breadcrumbs: navigation.buildBreadcrumbs(),
+        list,
       });
     },
-    err => next(err)
+    err => next(err),
   );
 };

hermione-custom-commands/index.js

@@ -0,0 +1,14 @@
+const assert = require('assert');
+
+module.exports = (hermione, opts) => {
+  hermione.on(hermione.events.NEW_BROWSER, (browser) => {
+    browser.addCommand('assertExists', (selector, msg) => browser.isExisting(selector)
+      .then((exists) => {
+        assert.ok(exists, msg);
+      }));
+    browser.addCommand('assertUrl', (actual, message) => browser.getUrl()
+      .then((url) => {
+        if (url !== actual) assert.fail(actual, message);
+      }));
+  });
+};

hermione-custom-commands/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "hermione-custom-commands",
+  "version": "1.0.0",
+  "main": "index.js"
+}

hermione-html-reporter/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>HTML report</title>
+<meta charset="utf-8">
+<link href="report.min.css" rel="stylesheet"></head>
+<body class="report">
+    <div id="app"></div>
+<script type="text/javascript" src="data.js"></script><script type="text/javascript" src="report.min.js"></script></body>
+</html>