鱼皮AI导航
鱼皮AI导航
  • 主页
  • 社区
  • AI工具
  • AI知识库
  • AI提示词
  • MCP
  • Skills
  • AI学习资源
  • AI资讯
  • GitHub开源
登录/注册

prowler-test-sdk

为 Prowler SDK 提供多云环境下的单元测试支持,针对 AWS 使用 moto 实现服务虚拟化,对 Azure、GCP 等其他平台采用 MagicMock 进行客户端模拟,确保检查逻辑在无真实资源情况下可验证状态判定与结果输出。

测试与安全
访问 GitHub
文档Skills.MD
name
prowler-test-sdk
description
Testing patterns for Prowler SDK (Python). Trigger: When writing tests for the Prowler SDK (checks/services/providers), including provider-specific mocking rules (moto for AWS only).
license
Apache-2.0
metadata{"author":"prowler-cloud","version":"1.0","scope":["root","sdk"],"auto_invoke":["Writing Prowler SDK tests","Mocking AWS with moto in tests"]}
allowed-tools
Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch, Task

Generic Patterns: For base pytest patterns (fixtures, mocking, parametrize, markers), see the pytest skill. This skill covers Prowler-specific conventions only.

Full Documentation: docs/developer-guide/unit-testing.mdx

CRITICAL: Provider-Specific Testing

ProviderMocking ApproachDecorator
AWSmoto library@mock_aws
Azure, GCP, K8s, othersMagicMockNone

NEVER use moto for non-AWS providers. NEVER use MagicMock for AWS.


AWS Check Test Pattern

▼
python
复制代码
from unittest import mock from boto3 import client from moto import mock_aws from tests.providers.aws.utils import AWS_REGION_US_EAST_1, set_mocked_aws_provider class Test_{check_name}: @mock_aws def test_no_resources(self): from prowler.providers.aws.services.{service}.{service}_service import {ServiceClass} aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1]) with mock.patch( "prowler.providers.common.provider.Provider.get_global_provider", return_value=aws_provider, ): with mock.patch( "prowler.providers.aws.services.{service}.{check_name}.{check_name}.{service}_client", new={ServiceClass}(aws_provider), ): from prowler.providers.aws.services.{service}.{check_name}.{check_name} import ( {check_name}, ) check = {check_name}() result = check.execute() assert len(result) == 0 @mock_aws def test_{check_name}_pass(self): # Setup AWS resources with moto {service}_client = client("{service}", region_name=AWS_REGION_US_EAST_1) # Create compliant resource... from prowler.providers.aws.services.{service}.{service}_service import {ServiceClass} aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1]) with mock.patch( "prowler.providers.common.provider.Provider.get_global_provider", return_value=aws_provider, ): with mock.patch( "prowler.providers.aws.services.{service}.{check_name}.{check_name}.{service}_client", new={ServiceClass}(aws_provider), ): from prowler.providers.aws.services.{service}.{check_name}.{check_name} import ( {check_name}, ) check = {check_name}() result = check.execute() assert len(result) == 1 assert result[0].status == "PASS" @mock_aws def test_{check_name}_fail(self): # Setup AWS resources with moto {service}_client = client("{service}", region_name=AWS_REGION_US_EAST_1) # Create non-compliant resource... from prowler.providers.aws.services.{service}.{service}_service import {ServiceClass} aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1]) with mock.patch( "prowler.providers.common.provider.Provider.get_global_provider", return_value=aws_provider, ): with mock.patch( "prowler.providers.aws.services.{service}.{check_name}.{check_name}.{service}_client", new={ServiceClass}(aws_provider), ): from prowler.providers.aws.services.{service}.{check_name}.{check_name} import ( {check_name}, ) check = {check_name}() result = check.execute() assert len(result) == 1 assert result[0].status == "FAIL"

Critical: Always import the check INSIDE the mock.patch context to ensure proper client mocking.


Azure Check Test Pattern

NO moto decorator. Use MagicMock to mock the service client directly.

▼
python
复制代码
from unittest import mock from uuid import uuid4 from prowler.providers.azure.services.{service}.{service}_service import {ResourceModel} from tests.providers.azure.azure_fixtures import ( AZURE_SUBSCRIPTION_ID, set_mocked_azure_provider, ) class Test_{check_name}: def test_no_resources(self): {service}_client = mock.MagicMock {service}_client.{resources} = {} with ( mock.patch( "prowler.providers.common.provider.Provider.get_global_provider", return_value=set_mocked_azure_provider(), ), mock.patch( "prowler.providers.azure.services.{service}.{check_name}.{check_name}.{service}_client", new={service}_client, ), ): from prowler.providers.azure.services.{service}.{check_name}.{check_name} import ( {check_name}, ) check = {check_name}() result = check.execute() assert len(result) == 0 def test_{check_name}_pass(self): resource_id = str(uuid4()) resource_name = "Test Resource" {service}_client = mock.MagicMock {service}_client.{resources} = { AZURE_SUBSCRIPTION_ID: { resource_id: {ResourceModel}( id=resource_id, name=resource_name, location="westeurope", # ... compliant attributes ) } } with ( mock.patch( "prowler.providers.common.provider.Provider.get_global_provider", return_value=set_mocked_azure_provider(), ), mock.patch( "prowler.providers.azure.services.{service}.{check_name}.{check_name}.{service}_client", new={service}_client, ), ): from prowler.providers.azure.services.{service}.{check_name}.{check_name} import ( {check_name}, ) check = {check_name}() result = check.execute() assert len(result) == 1 assert result[0].status == "PASS" assert result[0].subscription == AZURE_SUBSCRIPTION_ID assert result[0].resource_name == resource_name def test_{check_name}_fail(self): resource_id = str(uuid4()) resource_name = "Test Resource" {service}_client = mock.MagicMock {service}_client.{resources} = { AZURE_SUBSCRIPTION_ID: { resource_id: {ResourceModel}( id=resource_id, name=resource_name, location="westeurope", # ... non-compliant attributes ) } } with ( mock.patch( "prowler.providers.common.provider.Provider.get_global_provider", return_value=set_mocked_azure_provider(), ), mock.patch( "prowler.providers.azure.services.{service}.{check_name}.{check_name}.{service}_client", new={service}_client, ), ): from prowler.providers.azure.services.{service}.{check_name}.{check_name} import ( {check_name}, ) check = {check_name}() result = check.execute() assert len(result) == 1 assert result[0].status == "FAIL"

GCP/Kubernetes/Other Providers

Follow the same MagicMock pattern as Azure:

▼
python
复制代码
from tests.providers.gcp.gcp_fixtures import set_mocked_gcp_provider, GCP_PROJECT_ID from tests.providers.kubernetes.kubernetes_fixtures import set_mocked_kubernetes_provider

Key difference: Each provider has its own fixtures file with set_mocked_{provider}_provider.


Provider Fixtures Reference

ProviderFixtures FileKey Constants
AWStests/providers/aws/utils.pyAWS_REGION_US_EAST_1, AWS_ACCOUNT_NUMBER
Azuretests/providers/azure/azure_fixtures.pyAZURE_SUBSCRIPTION_ID
GCPtests/providers/gcp/gcp_fixtures.pyGCP_PROJECT_ID
K8stests/providers/kubernetes/kubernetes_fixtures.py-

Test File Structure

▼
text
复制代码
tests/providers/{provider}/services/{service}/ ├── {service}_service_test.py # Service tests └── {check_name}/ └── {check_name}_test.py # Check tests

NOTE: Do not create a __init__.py file in the test folder.


Required Test Scenarios

Every check MUST test:

ScenarioExpected
Resource compliantstatus == "PASS"
Resource non-compliantstatus == "FAIL"
No resourceslen(results) == 0

Assertions to Include

▼
python
复制代码
# Always verify these assert result[0].status == "PASS" # or "FAIL" assert result[0].status_extended == "Expected message..." assert result[0].resource_id == expected_id assert result[0].resource_name == expected_name # Provider-specific assert result[0].region == "us-east-1" # AWS assert result[0].subscription == AZURE_SUBSCRIPTION_ID # Azure assert result[0].project_id == GCP_PROJECT_ID # GCP

Commands

▼
bash
复制代码
# All SDK tests poetry run pytest -n auto -vvv tests/ # Specific provider poetry run pytest tests/providers/{provider}/ -v # Specific check poetry run pytest tests/providers/{provider}/services/{service}/{check_name}/ -v # Stop on first failure poetry run pytest -x tests/

Resources

  • Templates: See assets/ for complete test templates (AWS with moto, Azure/GCP with MagicMock)
  • Documentation: See references/testing-docs.md for official Prowler Developer Guide links
测试与安全

快捷安装

复制到终端去安装 Skill

npxskillsaddprowler-cloud/prowler--skill"prowler-test-sdk"
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
🔥热门工具
朱雀AI检测朱雀AI检测
朱雀AI检测助手朱雀AI检测助手
LovartLovart
老鱼简历老鱼简历
WritePass官网WritePass官网
面多多面多多
CursorCursor
星月写作星月写作
朱雀AI检测助手朱雀AI检测助手
零感AI零感AI
Skills 推荐
debug
debug 是一个系统化定位软件缺陷根因的技能,适用于用户报告 'fix'、'broken'、'error' 等问题或测试意外失败时。它通过可验证的假设、最小复现、因果链分析和回归测试,确保在修复前准确定位根本原因。
webapp-testing
提供本地 Web 应用的端到端测试能力,支持页面导航、元素交互、表单填写、动态等待、断言验证、截图捕获、浏览器日志收集及网络请求拦截,适用于前端功能验证与 UI 行为调试。
tdd-process
严格遵循测试驱动开发的红绿重构循环,强制执行先写测试、失败要有意义、实现最小化、验证全覆盖的全流程,确保每次代码变更都由可执行的测试用例驱动并经编译、检查与全量验证确认。
smoke-test
自动化创建 Mastra 项目并完成 Studio 全流程冒烟测试,涵盖项目初始化、环境配置、本地服务启动及 Chrome 浏览器中对 Agents、Tools、Workflows、Scorers 等核心模块的功能验证与截图记录。
property-based-testing
通过生成随机输入验证代码在各类边界条件下的行为一致性,适用于序列化、解析、归一化及纯函数等场景,能有效发现隐含缺陷并提升测试覆盖率,尤其适合需要高可靠性的算法与智能合约验证。