npm install -g purpleteam

Если вы хотите отлаживать

Клонируйте этот репозиторий.

Конфигурация

Скопируйте config/config.example.json в config/config.local.json или config/config.cloud.json в зависимости от того, какую среду вы планируете использовать.
Используйте config/config.js для документации и дополнительных примеров.

loggers.testerProgress.dirname Настройте это значение.

purpleteamApi Если вы планируете использовать среду local, можете оставить значения свойств по умолчанию. Если вы планируете использовать среду cloud, эта информация будет предоставлена вам при регистрации учётной записи purpleteam.

testerFeedbackComms.medium Long Polling (lp) поддерживается как в среде local, так и в cloud. Server Sent Events (sse) поддерживается только в среде local из-за ограничений AWS. И lp, и sse работают в реальном времени. Обе реализации имеют свои плюсы и минусы.

Использование sse — это односторонняя связь после первоначальной подписки CLI на оркестратор. Redis pub/sub используется между тестерами и оркестратором для публикации обратной связи от тестеров. Если CLI будет остановлен (не подписан) в любой момент, пока бэкенд выполняет тестовый прогон, события будут потеряны.

Использование lp — это связь типа запрос-ответ. Запрос отправляется и получает ответ только тогда, когда доступны сообщения обратной связи от тестеров, или превышен тайм-аут, специфичный для приложения (а не AWS Api Gateway). Как только CLI получает набор (один или несколько) сообщений обратной связи, он отправляет новый запрос к оркестратору (если работает в среде local) или API (если в среде cloud). Redis pub/sub используется между тестерами и оркестратором для публикации обратной связи.
Если первоначальный запрос CLI на обратную связь от тестеров будет сделан сразу после начала тестирования, сообщения обратной связи будут сохраняться в памяти в списках Redis. Это означает, что если CLI будет временно остановлен во время тестового прогона, при его перезапуске он получит те сообщения обратной связи, которые поступили на оркестратор, когда CLI не работал... при условии, что оркестратор продолжает работать.

Дополнительная информация: это может измениться в будущем; WebSockets также является опцией, которую мы можем реализовать в будущем, но реализация WebSockets означала бы, что нам придётся изменить весь наш подход к аутентификации. Выбранная нами облачная инфраструктура AWS Api Gateway не поддерживает потоковую передачу и не поддерживает поток OAuth Client Credentials с Cognito User Pools.

purpleteamAuth Если вы планируете использовать среду local, можете оставить значения свойств по умолчанию. Если вы планируете использовать среду cloud, эта информация будет предоставлена вам при регистрации учётной записи purpleteam.

buildUserConfig.fileUri Настройте это значение, если вы не хотите передавать его вручную в качестве аргумента CLI. Это файл Job, который вы настроили для указания деталей вашей тестируемой системы (SUT).

outcomes.dir Настройте это значение. Это директория по вашему выбору, в которую будут сохраняться файлы результатов от оркестратора (если работает в среде local) или API (если в среде cloud).