GRM-24: docs: document bandit in README, CONTRIBUTING and .gitignore
This commit is contained in:
@@ -25,6 +25,10 @@ build/
|
|||||||
.coverage
|
.coverage
|
||||||
htmlcov/
|
htmlcov/
|
||||||
|
|
||||||
|
# Security scanner
|
||||||
|
.bandit
|
||||||
|
bandit-report.*
|
||||||
|
|
||||||
# Misc
|
# Misc
|
||||||
*.log
|
*.log
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|||||||
+3
-1
@@ -43,7 +43,8 @@ This format is enforced by the auto-merge workflow, which validates the PR title
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
make test-all # Runs pytest-cov + molecule
|
make test-all # Runs pytest-cov + molecule
|
||||||
make lint-all # Runs ruff, pyright, ansible-lint, checkmake
|
make lint-all # Runs ruff, pyright, bandit, ansible-lint, checkmake
|
||||||
|
make lint-bandit # Security scan with bandit
|
||||||
make pytest-cov # Unit tests with 100% coverage enforcement
|
make pytest-cov # Unit tests with 100% coverage enforcement
|
||||||
make molecule # All 7 molecule scenarios
|
make molecule # All 7 molecule scenarios
|
||||||
```
|
```
|
||||||
@@ -52,5 +53,6 @@ make molecule # All 7 molecule scenarios
|
|||||||
|
|
||||||
- **ruff**: Line length 120
|
- **ruff**: Line length 120
|
||||||
- **pyright**: Strict mode
|
- **pyright**: Strict mode
|
||||||
|
- **bandit**: Security scan for Python code (no high/medium severity issues)
|
||||||
- **Test coverage**: 100% required
|
- **Test coverage**: 100% required
|
||||||
- **ansible-lint**: For all Ansible content
|
- **ansible-lint**: For all Ansible content
|
||||||
|
|||||||
@@ -292,7 +292,8 @@ source .venv/bin/activate
|
|||||||
### Running Linters
|
### Running Linters
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make lint # Python (ruff + pyright)
|
make lint # Python (ruff + pyright + bandit)
|
||||||
|
make lint-bandit # Security scan only
|
||||||
make ansible-lint # Ansible
|
make ansible-lint # Ansible
|
||||||
make makefile-lint # Makefile
|
make makefile-lint # Makefile
|
||||||
```
|
```
|
||||||
@@ -388,7 +389,8 @@ The test checks two things:
|
|||||||
| `status` | Checks runner status |
|
| `status` | Checks runner status |
|
||||||
| `remove` | Removes a runner completely |
|
| `remove` | Removes a runner completely |
|
||||||
| `list` | Lists registered runners with live status |
|
| `list` | Lists registered runners with live status |
|
||||||
| `lint` | Runs Python linters |
|
| `lint` | Runs Python linters (ruff, pyright, bandit) |
|
||||||
|
| `lint-bandit` | Runs `bandit` security scanner |
|
||||||
| `ansible-lint` | Runs `ansible-lint` |
|
| `ansible-lint` | Runs `ansible-lint` |
|
||||||
| `test-unit` | Runs unit tests with coverage |
|
| `test-unit` | Runs unit tests with coverage |
|
||||||
| `test-integration` | Runs integration tests |
|
| `test-integration` | Runs integration tests |
|
||||||
|
|||||||
Reference in New Issue
Block a user