YAML Test Project - Подробное руководство

Этот проект создан для изучения YAML файлов и автоматизации тестирования через практическое задание в GitVerse Class.

Что вы изучите

• YAML синтаксис - структуру и правила написания YAML файлов
• Автоматизация тестирования - настройка автоматической проверки кода
• Bash команды - основные команды для работы с файлами и процессами
• Контроль версий - работу с Git и Pull Request'ами в GitVerse Class

Структура проекта

• student_template.yml
  - шаблон для студентов с местом для заполнения команды (студенты редактируют этот файл)
• CONTRIBUTING.md
  - подробная инструкция (этот файл)

Задание для студентов

Вам нужно настроить автоматическую проверку кода, которая будет тестировать три условия:

1. Наличие файла
   README.md
   в корне проекта
2. Наличие папки
   src
3. Наличие программы в папке
   src
   , которая выводит "Hello world"

Пошаговое руководство

Шаг 0: Новая ветка

1. Создайте новую ветку в которой будут происходить все изменения

Шаг 1: Изучите структуру проекта

Изучите файлы проекта:

• Откройте
  student_template.yml
  - это ваш шаблон для работы (вы будете редактировать этот файл)

Шаг 2: Отредактируйте файл student_template.yml

1. Отредактируйте файл
   student_template.yml
   прямо в репозитории
2. Заполните все три команды в тестах (замените комментарии-заполнители на реальные команды)

Шаг 3: Заполните первые два теста

В файле

первые два теста имеют комментарии-заполнители вместо команд. Вам нужно:

Тест 1: Заполнить команду для проверки наличия файла README.md

Тест 2: Заполнить команду для проверки наличия папки src

Шаг 4: Заполните третий тест

Вам нужно заполнить команду в третьем тесте. Третий тест должен:

1. Выполнить программу из папки
   src
2. Убедиться, что она выводит "Hello world"

Шаг 5: Создайте файл программы

Создайте в папке

файл программы на любом языке программирования, которая выводит "Hello world".

Требования к программе:

• Должна выводить текст "Hello world" (без кавычек)
• Должна запускаться из командной строки
• Имя файла может быть любым (например,
  hello.py
  ,
  hello.js
  ,
  hello.sh
  )

Шаг 7: Создайте запрос на слияние

1. Создайте запрос на слияние в master
2. Дождитесь автоматической проверки

Шаг 8: Анализ результатов

После создания Pull Request система автоматически:

• Проверит наличие README.md (ваш Тест 1)
• Проверит наличие папки src (ваш Тест 2)
• Выполнит вашу программу и проверит вывод (ваш Тест 3)
• Проверит правильность заполнения всех команд в файле student_template.yml (Тест 4)

Возможные ошибки и их решения

Ошибка: "File not found"

• Убедитесь, что файлы находятся в правильных местах
• Проверьте регистр букв в именах файлов

Ошибка: "Command not found"

• Убедитесь, что команда написана правильно
• Проверьте, что интерпретатор (python3, node) установлен в системе

Ошибка: "Wrong output"

• Убедитесь, что ваша программа выводит именно "Hello world"
• Проверьте пробелы и регистр букв

Ошибка: "Test command is empty or not filled"

• Убедитесь, что вы заполнили все три команды в student_template.yml
• Замените комментарии-заполнители на реальные команды

Дополнительные ресурсы

• Документация YAML
• Bash scripting tutorial
• GitVerse Class - платформа для обучения

Вопросы?

Если у вас возникнут вопросы:

1. Проверьте раздел "Возможные ошибки"
2. Посмотрите примеры решений
3. Свяжитесь с преподавателем

Удачи в изучении YAML и автоматизации тестирования!