Skip to content
TheChatArchiveThe Chat Archive
o1-preview-2024-09-12· OpenAIAi2 WildChat-4.8M (AI2)

Как это сделать: Set up Jest debugging a. Acceptance criteria: configure a ‘debug…

  1. User

    Как это сделать: Set up Jest debugging a. Acceptance criteria: configure a ‘debug current file’ that should run tests from the current file and demonstrate how you add breakpoints during test execution Вот мой сервер: require('dotenv').config(); const express = require('express'); const cors = require('cors'); const cards = require('./cards'); const app = express(); const PORT = 5000;

    app.use(cors()); app.use(express.json()); app.use('/img', express.static('img'));

    const validUsername = process.env.USERNAME; const validPassword = process.env.PASSWORD;

    app.post('/login', (req, res) => { const { username, password } = req.body;
    if (username === validUsername && password === validPassword) { res.status(200).json({ message: 'Login successful' }); } else { res.status(401).json({ message: 'Invalid username or password' }); } });

    app.get('/api/cards', (req, res) => { const { search } = req.query;

    if (search) {
        const searchLower = search.toLowerCase();
        const filteredCards = cards.filter((cardObj) => {
            const title = cardObj.card.text.heading.toLowerCase();
            const description = cardObj.card.text.description.toLowerCase();
            return (
                title.includes(searchLower) || description.includes(searchLower)
            );
        });
    
        return res.status(200).json(filteredCards);
    }
    
    res.status(200).json(cards);
    

    });

    app.listen(PORT, () => { console.log(Server is running on port ${PORT}); });, вот package, добавь тут всё: { "name": "server", "version": "1.0.0", "main": "index.js", "scripts": { "test": "jest", "dev": "nodemon index.js", "start": "node index.js" }, "keywords": [], "author": "", "license": "ISC", "description": "", "dependencies": { "cors": "^2.8.5", "dotenv": "^16.4.5", "express": "^4.21.0", "path": "^0.12.7", "redux-thunk": "^3.1.0", "server": "file: " }, "devDependencies": { "@testing-library/jest-dom": "^6.5.0", "@testing-library/react": "^16.0.1", "jest": "^29.7.0", "nodemon": "^3.1.7", "redux-mock-store": "^1.5.4" } }

  2. Assistant

    Для того чтобы настроить отладку Jest и иметь возможность запускать отладку текущего файла с тестами и устанавливать точки останова, выполните следующие шаги:

    Шаг 1: Убедитесь, что Jest установлен

    У вас в devDependencies уже есть "jest": "^29.7.0". Убедитесь, что вы установили все зависимости, выполнив команду:

    npm install
    

    Шаг 2: Экспортируйте ваше приложение Express

    В вашем файле index.js (сервер) вам необходимо экспортировать экземпляр приложения Express, чтобы иметь возможность импортировать его в тестах.

    Измените ваш index.js, добавив следующую строку в конце файла:

    module.exports = app;
    

    Полный файл index.js будет выглядеть так:

    require('dotenv').config();
    const express = require('express');
    const cors = require('cors');
    const cards = require('./cards');
    const app = express();
    const PORT = 5000;
    
    app.use(cors());
    app.use(express.json());
    app.use('/img', express.static('img'));
    
    const validUsername = process.env.USERNAME;
    const validPassword = process.env.PASSWORD;
    
    app.post('/login', (req, res) => {
        const { username, password } = req.body;    
        if (username === validUsername && password === validPassword) {
            res.status(200).json({ message: 'Login successful' });
        } else {
            res.status(401).json({ message: 'Invalid username or password' });
        }
    });
    
    app.get('/api/cards', (req, res) => {
        const { search } = req.query;
    
        if (search) {
            const searchLower = search.toLowerCase();
            const filteredCards = cards.filter((cardObj) => {
                const title = cardObj.card.text.heading.toLowerCase();
                const description = cardObj.card.text.description.toLowerCase();
                return (
                    title.includes(searchLower) || description.includes(searchLower)
                );
            });
    
            return res.status(200).json(filteredCards);
        }
    
        res.status(200).json(cards);
    });
    
    app.listen(PORT, () => {
        console.log(`Server is running on port ${PORT}`);
    });
    
    module.exports = app;
    

    Шаг 3: Создайте файл тестов

    Создайте файл index.test.js или server.test.js в том же каталоге, что и ваш index.js. Пример содержимого файла теста:

    const request = require('supertest');
    const app = require('./index');
    
    describe('Тестирование маршрутов API', () => {
        it('Должен получить список карточек', async () => {
            const response = await request(app).get('/api/cards');
            expect(response.statusCode).toBe(200);
            expect(Array.isArray(response.body)).toBeTruthy();
        });
    
        it('Должен отклонить неправильный логин', async () => {
            const response = await request(app)
                .post('/login')
                .send({ username: 'wrong', password: 'wrong' });
            expect(response.statusCode).toBe(401);
            expect(response.body.message).toBe('Invalid username or password');
        });
    });
    

    Не забудьте установить supertest для тестирования HTTP-запросов:

    npm install --save-dev supertest
    

    Добавьте supertest в ваши devDependencies в package.json:

    "devDependencies": {
        "@testing-library/jest-dom": "^6.5.0",
        "@testing-library/react": "^16.0.1",
        "jest": "^29.7.0",
        "nodemon": "^3.1.7",
        "redux-mock-store": "^1.5.4",
        "supertest": "^6.3.3"
    }
    

    Шаг 4: Создайте файл конфигурации Jest (необязательно)

    Если у вас нет особых требований, вы можете не создавать jest.config.js. Но если нужно, создайте jest.config.js в корне проекта со следующим содержимым:

    module.exports = {
      testEnvironment: 'node'
    };
    

    Шаг 5: Настройте конфигурацию для отладки в VSCode

    Создайте папку .vscode в корне вашего проекта, если ее нет. Внутри создайте файл launch.json со следующим содержимым:

    {
        "version": "0.2.0",
        "configurations": [
            {
                "name": "Отладка текущего теста Jest",
                "type": "node",
                "request": "launch",
                "program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
                "args": [
                    "${relativeFile}",
                    "--runInBand"
                ],
                "console": "integratedTerminal",
                "internalConsoleOptions": "neverOpen",
                "cwd": "${workspaceFolder}",
                "env": {
                    "NODE_ENV": "test"
                }
            }
        ]
    }
    

    Примечания:

    • Для Windows: Путь к Jest может отличаться. Убедитесь, что указанный путь корректен. Если возникает проблема, замените program на:

      "program": "${workspaceFolder}/node_modules/.bin/jest"
      
    • --runInBand заставляет Jest выполнять тесты последовательно, что необходимо для корректной отладки.

    Шаг 6: Установите точки останова в ваших тестах

    • Откройте ваш файл теста server.test.js в VSCode.
    • Установите точки останова, щелкнув слева от номера строки на той строке, где хотите остановиться во время отладки.

    Шаг 7: Запустите отладку

    • Перейдите в панель отладки в VSCode (иконка жука с перекрестием или нажмите Ctrl+Shift+D).
    • В верхнем выпадающем списке выберите конфигурацию Отладка текущего теста Jest.
    • Нажмите зеленую кнопку запуска или нажмите F5 для начала отладки.

    Отладчик запустит Jest для текущего файла тестов и остановится на ваших точках останова.

    Шаг 8: Отслеживайте переменные и выполняйте пошаговую отладку

    Когда отладчик остановится на точке останова, вы можете:

    • Навести курсор на переменные, чтобы увидеть их значения.
    • Использовать панель отладки для пошагового выполнения (Step Over, Step Into, Step Out).
    • Просматривать стек вызовов и локальные переменные в соответствующих панелях.

    Шаг 9: Обновите package.json, если необходимо

    Добавьте дополнительные скрипты для удобства запуска тестов:

    "scripts": {
        "test": "jest",
        "test:watch": "jest --watch",
        "test:coverage": "jest --coverage",
        "dev": "nodemon index.js",
        "start": "node index.js"
    }
    

    Убедитесь, что зависимости в package.json корректны. Ваш обновленный package.json будет выглядеть так:

    {
        "name": "server",
        "version": "1.0.0",
        "main": "index.js",
        "scripts": {
            "test": "jest",
            "test:watch": "jest --watch",
            "test:coverage": "jest --coverage",
            "dev": "nodemon index.js",
            "start": "node index.js"
        },
        "keywords": [],
        "author": "",
        "license": "ISC",
        "description": "",
        "dependencies": {
            "cors": "^2.8.5",
            "dotenv": "^16.4.5",
            "express": "^4.21.0",
            "path": "^0.12.7"
        },
        "devDependencies": {
            "@testing-library/jest-dom": "^6.5.0",
            "@testing-library/react": "^16.0.1",
            "jest": "^29.7.0",
            "nodemon": "^3.1.7",
            "redux-mock-store": "^1.5.4",
            "supertest": "^6.3.3"
        }
    }
    

    Примечания по зависимостям:

    • Удалите "server": "file: " из dependencies, так как это некорректно и может вызвать проблемы.
    • Если вы не используете redux-thunk и redux-mock-store на сервере, можно удалить их из зависимостей, если они не нужны.

    Шаг 10: Запустите тесты

    Вы можете запускать тесты из командной строки:

    • Просто тесты: npm test
    • Тесты с отслеживанием изменений: npm run test:watch
    • Тесты с покрытием: npm run test:coverage

    Шаг 11: Добавление точек останова во время выполнения тестов

    Теперь, когда вы настроили отладку, вы можете устанавливать точки останова не только в файлах тестов, но и в файлах исходного кода вашего приложения (например, index.js или других модулях). Отладчик остановится на этих точках во время выполнения тестов, и вы сможете отслеживать поведение вашего приложения.

    Дополнительные советы:

    • Коллекция тестов: Если у вас много тестов и вы хотите запускать отладку только для определенного, используйте метод test.only или describe.only в файле теста:

      test.only('Должен отклонить неправильный логин', async () => {
          // ваш тест
      });
      
    • Отладка асинхронного кода: Убедитесь, что вы используете async/await или корректно обрабатываете промисы в тестах, чтобы отладчик работал должным образом.

    • Использование debugger: Вы можете вставить ключевое слово debugger; в код вашего приложения или тестов. Отладчик остановится на этой строке, если запущен в режиме отладки.

    Заключение

    Вы успешно настроили отладку Jest в вашем проекте. Теперь вы можете запускать отладку текущего файла тестов и устанавливать точки останова для детального анализа выполнения вашего кода во время тестирования. Это существенно облегчит процесс разработки и поможет быстро находить и исправлять ошибки.

    Если у вас возникнут вопросы или проблемы, не стесняйтесь задавать их!