Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#303 Docs for build system #436

Merged
merged 2 commits into from
Jul 25, 2018
Merged

#303 Docs for build system #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a528d82
#303 Docs for build system
duker33 Jul 21, 2018
6627886
#303 Review#1 minor fixes. Some wording and and missed pdd task
duker33 Jul 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 26 additions & 0 deletions CI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Continuous integration
Выполняет две задачи:
- Проверка. Тестит систему для каждого pull request'a, запускает линтеры для кода.
- Сборка. Собирает систему для dev и prod после каждого пуша в мастер-ветку.

## Как устроен CI
CI делаем через drone. Синтаксис его конфига - надмножество конфигов docker-compose.

- При pull request сначала билдим контейнеры, потом запускаем на них тесты и линтеры.
- При push в мастер-ветку тоже билдим контейнеры, запускаем тесты.
В финале пушим вновь созданные образы (docker images) в репозиторий.
Docker compose фетчит эти образы на локальную машину когда мы начинаем разработку (или деплой на прод).
Мы лишь следуем инструкциям [из Makefile](README.md#Makefile).

## Тестирование
Образ питон-приложения для продакшена переиспользует образ для разработки.
Поэтому запускаем только один набор тестов для образа разработки.

Для интеграционных тестов фронтенда нужна собранная фронт-статика: css, js, images.
Поэтому билдим npm

# Кэширование
У текущей билд-системы Докера есть (были) проблемы с кэшированием,
поэтому каждый раз билдим только с флагом --no-cache.
# @todo #303:30m Try to rm --no-cache build flags from drone and Makefile.
# If it's impossible, write code comment.
24 changes: 16 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ bash alias dcp="docker-compose -f docker-compose-production.yml"

### Для разработки

**Готовим код к работе**
#### Готовим код к работе
```bash
git clone git@github.com:fidals/shopelectro.git
cd shopelectro/docker/
Expand All @@ -39,7 +39,7 @@ dc exec app python manage.py excel
dc exec app python manage.py price
```

**Файлы env**
#### Файлы env
`make deploy-dev` создаст файлы для окружения (env) со стандартными значениями.
А затем попросит заполнить их.
Пару рекомендаций по заполнению:
Expand All @@ -49,7 +49,7 @@ dc exec app python manage.py price
Проверяем адрес `http://127.0.0.1:8010` - загружается сайт.
Вместо порта `8010` может быть другой - переменная окружения (env var) `VIRTUAL_HOST_EXPOSE_PORT`.

**Установка refarm-site**
#### Установка refarm-site
Сайт использует refarm-site как внешнюю зависимость.
Интерфейс refarm-site нестабилен,
поэтому иногда при разработке фичи сайта
Expand All @@ -58,11 +58,12 @@ dc exec app python manage.py price
И примонтировать внутрь контейнера app.
Смотрите на переменную окружения `REFARM_SITE`.

**Makefile**
`docker/Makefile` содержит все скрипты, которые мы используем для разработки.
#### Makefile
`docker/Makefile` - единственная и полная инструкция для работы с локальным dev-окружением.
Содержит все скрипты, которые мы используем для разработки.
Например: подготовка среды, запуск тестов, внутренних команд приложения.

**Запускаем тесты**
#### Запускаем тесты
```
# запускаем все тесты.
make test
Expand All @@ -72,7 +73,7 @@ dc exec app python manage.py test -v 3 --liveserver=app:8021-8029 \
stroyprombeton.tests.tests_selenium.CartTestCase.buy_on_product_page
```

**Fixtures**
#### Fixtures
Некоторые тесты используют fixtures.
Это заранее подготовленные данные из базы.
Подробнее о фикстурах [в документации Django](https://docs.djangoproject.com/en/1.11/topics/testing/tools/#fixture-loading).
Expand All @@ -83,7 +84,7 @@ dc exec app python manage.py test -v 3 --liveserver=app:8021-8029 \
Для пересоздания фикстур используйте команду `shopelectro/management/commands/test_db.py`
Файл `dump.json` в контроле версий всегда должен соответстовать коду команды `test_db`.

**Админка**
#### Админка
Адрес: /admin/

Логин/пароль:
Expand Down Expand Up @@ -127,6 +128,13 @@ make backup

N.B.: Некоторые данные (например, медиафайлы) могут иметь большой размер. На момент написания этой заметки, архив с медиафайлами Shopelectro весил ~4GB.

# Continuous integration
Выполняет две задачи:
- Проверка. Тестит систему для каждого pull request'a, запускает линтеры для кода.
- Сборка. Собирает систему для dev и prod после каждого пуша в мастер-ветку.

[Как устроен CI внутри](CI.md).

# Инструкции к фичам
- [Retail Tags](https://github.com/fidals/shopelectro/blob/master/doc/tags.md)
- [SEO Templates](https://github.com/fidals/shopelectro/blob/master/doc/seo_templates.md)
Expand Down