Skip to content

Commit 34a6af9

Browse files
Copilotchefgs
Copilot
and
chefgs
committed
Fix scaffold subcommands failing with unrecognized arguments via devopsos CLI
When invoked as `python -m cli.devopsos scaffold <target>`, the scaffold module's argparse would read sys.argv and see 'scaffold <target>' as unrecognized arguments. Fix by saving and restoring sys.argv around each scaffold main() call in devopsos.py so argparse falls back to env-var/ default values. Add regression tests for gha, gitlab and argocd. Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
1 parent f8d2666 commit 34a6af9

11 files changed

Lines changed: 780 additions & 16 deletions

‎.github/workflows/devops-os-complete.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: DevOps-OS CI/CD
2+
'on':
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
branches:
8+
- main
9+
workflow_dispatch:
10+
inputs:
11+
environment:
12+
description: Environment to deploy to
13+
required: true
14+
default: dev
15+
type: choice
16+
options:
17+
- dev
18+
- test
19+
- staging
20+
- prod
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
container:
25+
image: ghcr.io/yourorg/devops-os:latest
26+
options: --user root
27+
steps:
28+
- name: Checkout code
29+
uses: actions/checkout@v3
30+
- name: Set up build environment
31+
run: echo 'Setting up build environment for DevOps-OS'
32+
- name: Install Python dependencies
33+
run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
34+
- name: Build Python package
35+
run: if [ -f setup.py ]; then pip install -e .; elif [ -f pyproject.toml ];
36+
then pip install -e .; fi
37+
- name: Install Node.js dependencies
38+
run: if [ -f package.json ]; then npm ci; fi
39+
- name: Build JavaScript/TypeScript
40+
run: if [ -f package.json ]; then npm run build --if-present; fi
41+
- name: Upload build artifacts
42+
uses: actions/upload-artifact@v3
43+
with:
44+
name: build-artifacts
45+
path: dist/
46+
retention-days: 1
47+
test:
48+
needs:
49+
- build
50+
runs-on: ubuntu-latest
51+
container:
52+
image: ghcr.io/yourorg/devops-os:latest
53+
options: --user root
54+
steps:
55+
- name: Checkout code
56+
uses: actions/checkout@v3
57+
- name: Set up test environment
58+
run: echo 'Setting up test environment for DevOps-OS'
59+
- name: Install Python dependencies
60+
run: if [ -f requirements.txt ]; then pip install -r requirements.txt pytest
61+
pytest-cov; fi
62+
- name: Run Python tests
63+
run: if [ -d tests ]; then python -m pytest --cov=./ --cov-report=xml; fi
64+
- name: Run Pylint
65+
run: if command -v pylint &> /dev/null; then pylint --disable=C0111 **/*.py;
66+
fi
67+
- name: Install Node.js dependencies
68+
run: if [ -f package.json ]; then npm ci; fi
69+
- name: Run JavaScript tests
70+
run: if [ -f package.json ]; then npm test; fi
71+
- name: Run ESLint
72+
run: if [ -f package.json ] && grep -q eslint package.json; then npm run lint;
73+
fi
74+
- name: Upload test results
75+
uses: actions/upload-artifact@v3
76+
with:
77+
name: test-results
78+
path: test-reports/
79+
retention-days: 1
80+
- name: Upload coverage reports
81+
uses: codecov/codecov-action@v3
82+
with:
83+
files: ./coverage.xml,./coverage/lcov.info
84+
fail_ci_if_error: false
85+
deploy:
86+
needs:
87+
- test
88+
if: github.ref == 'refs/heads/main'
89+
runs-on: ubuntu-latest
90+
container:
91+
image: ghcr.io/yourorg/devops-os:latest
92+
options: --user root
93+
steps:
94+
- name: Checkout code
95+
uses: actions/checkout@v3
96+
- name: Set up deployment environment
97+
run: echo 'Setting up deployment environment for DevOps-OS'
98+
- name: Build and Push Docker Image
99+
if: github.ref == 'refs/heads/main'
100+
run: 'echo "${{ secrets.REGISTRY_TOKEN }}" | docker login ghcr.io -u ${{ github.actor
101+
}} --password-stdin
102+
103+
docker build -t ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name
104+
}}:latest .
105+
106+
docker push ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name
107+
}}:latest'

‎.gitlab-ci.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
stages:
2+
- build
3+
- test
4+
variables:
5+
APP_NAME: my-app
6+
IMAGE_TAG: $CI_COMMIT_SHORT_SHA
7+
REGISTRY: $CI_REGISTRY
8+
REGISTRY_IMAGE: $CI_REGISTRY_IMAGE
9+
build:
10+
stage: build
11+
image: docker:24
12+
services:
13+
- docker:24-dind
14+
variables:
15+
DOCKER_TLS_CERTDIR: /certs
16+
script:
17+
- if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
18+
- if [ -f setup.py ] || [ -f pyproject.toml ]; then pip install -e .; fi
19+
- echo "$CI_REGISTRY_PASSWORD" | docker login -u "$CI_REGISTRY_USER" --password-stdin
20+
"$CI_REGISTRY"
21+
- docker build -t $REGISTRY_IMAGE:$IMAGE_TAG .
22+
- docker push $REGISTRY_IMAGE:$IMAGE_TAG
23+
- docker tag $REGISTRY_IMAGE:$IMAGE_TAG $REGISTRY_IMAGE:latest
24+
- docker push $REGISTRY_IMAGE:latest
25+
rules:
26+
- if: $CI_COMMIT_BRANCH
27+
when: always
28+
test:python:
29+
stage: test
30+
image: python:3.11-slim
31+
script:
32+
- if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
33+
- pip install pytest pytest-cov
34+
- if [ -d tests ] || [ -d test ]; then python -m pytest --cov=./ --cov-report=xml
35+
-v; fi
36+
coverage: /TOTAL.*\s+(\d+%)$/
37+
artifacts:
38+
reports:
39+
coverage_report:
40+
coverage_format: cobertura
41+
path: coverage.xml
42+
when: always
43+
rules:
44+
- if: $CI_COMMIT_BRANCH
45+
when: always
46+
- if: $CI_MERGE_REQUEST_ID
47+
when: always

‎Jenkinsfile‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
pipeline {
2+
agent {
3+
docker {
4+
image 'docker.io/yourorg/devops-os:latest'
5+
args '-v /var/run/docker.sock:/var/run/docker.sock -u root'
6+
}
7+
}
8+
environment {
9+
WORKSPACE_DIR = '${WORKSPACE}'
10+
REGISTRY_URL = params.REGISTRY_URL ?: 'docker.io'
11+
IMAGE_NAME = params.IMAGE_NAME ?: 'devops-os-app'
12+
IMAGE_TAG = params.IMAGE_TAG ?: 'latest'
13+
PYTHON_ENABLED = params.PYTHON_ENABLED ?: true
14+
JAVA_ENABLED = params.JAVA_ENABLED ?: false
15+
JAVASCRIPT_ENABLED = params.JAVASCRIPT_ENABLED ?: true
16+
GO_ENABLED = params.GO_ENABLED ?: false
17+
}
18+
options {
19+
timestamps()
20+
timeout(time: 60, unit: 'MINUTES')
21+
buildDiscarder(logRotator(numToKeepStr: '10'))
22+
disableConcurrentBuilds()
23+
ansiColor('xterm')
24+
}
25+
stages {
26+
stage('Build') {
27+
steps {
28+
checkout scm
29+
sh '''
30+
if [ ${PYTHON_ENABLED} = 'true' ] && [ -f requirements.txt ]; then
31+
pip install -r requirements.txt
32+
fi
33+
if [ ${PYTHON_ENABLED} = 'true' ] && [ -f setup.py ]; then
34+
pip install -e .
35+
elif [ ${PYTHON_ENABLED} = 'true' ] && [ -f pyproject.toml ]; then
36+
pip install -e .
37+
fi
38+
'''
39+
sh '''
40+
if [ ${JAVASCRIPT_ENABLED} = 'true' ] && [ -f package.json ]; then
41+
npm ci
42+
npm run build --if-present
43+
fi
44+
'''
45+
archiveArtifacts artifacts: '**/target/*.jar, **/dist/*, **/build/*, **/*.zip, **/*.tar.gz', allowEmptyArchive: true
46+
}
47+
}
48+
stage('Test') {
49+
steps {
50+
sh '''
51+
if [ ${PYTHON_ENABLED} = 'true' ] && [ -f requirements.txt ]; then
52+
pip install -r requirements.txt pytest pytest-cov
53+
fi
54+
if [ ${PYTHON_ENABLED} = 'true' ] && [ -d tests ]; then
55+
python -m pytest --cov=./ --cov-report=xml
56+
fi
57+
'''
58+
sh '''
59+
if [ ${PYTHON_ENABLED} = 'true' ] && command -v pylint &> /dev/null; then
60+
pylint --disable=C0111 **/*.py || true
61+
fi
62+
'''
63+
sh '''
64+
if [ ${JAVASCRIPT_ENABLED} = 'true' ] && [ -f package.json ]; then
65+
npm test || true
66+
fi
67+
'''
68+
sh '''
69+
if [ ${JAVASCRIPT_ENABLED} = 'true' ] && [ -f package.json ] && grep -q eslint package.json; then
70+
npm run lint || true
71+
fi
72+
'''
73+
junit '**/target/surefire-reports/*.xml, **/test-results/*.xml, **/junit-reports/*.xml', allowEmptyResults: true
74+
}
75+
}
76+
stage('Deploy') {
77+
when {
78+
expression {
79+
return env.ENVIRONMENT != 'prod' || (env.ENVIRONMENT == 'prod' && currentBuild.resultIsBetterOrEqualTo('SUCCESS'))
80+
}
81+
}
82+
steps {
83+
script {
84+
def imageName = "${REGISTRY_URL}/${IMAGE_NAME}:${IMAGE_TAG}"
85+
docker.withRegistry('https://' + REGISTRY_URL, 'registry-credentials') {
86+
def customImage = docker.build(imageName)
87+
customImage.push()
88+
}
89+
}
90+
sh '''
91+
echo "Deployment completed successfully"
92+
'''
93+
}
94+
}
95+
}
96+
post {
97+
always {
98+
cleanWs()
99+
}
100+
success {
101+
echo 'Pipeline completed successfully!'
102+
}
103+
failure {
104+
echo 'Pipeline failed!'
105+
}
106+
}
107+
}

‎argocd/application.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
apiVersion: argoproj.io/v1alpha1
2+
kind: Application
3+
metadata:
4+
name: my-app
5+
namespace: argocd
6+
labels:
7+
app.kubernetes.io/name: my-app
8+
spec:
9+
project: default
10+
source:
11+
repoURL: https://github.com/myorg/my-app.git
12+
targetRevision: HEAD
13+
path: k8s
14+
destination:
15+
server: https://kubernetes.default.svc
16+
namespace: default
17+
syncPolicy:
18+
syncOptions:
19+
- CreateNamespace=true

‎argocd/appproject.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
apiVersion: argoproj.io/v1alpha1
2+
kind: AppProject
3+
metadata:
4+
name: default
5+
namespace: argocd
6+
spec:
7+
description: Project for my-app deployments
8+
sourceRepos:
9+
- https://github.com/myorg/my-app.git
10+
destinations:
11+
- namespace: default
12+
server: https://kubernetes.default.svc
13+
- namespace: argocd
14+
server: https://kubernetes.default.svc
15+
clusterResourceWhitelist:
16+
- group: '*'
17+
kind: Namespace
18+
namespaceResourceWhitelist:
19+
- group: apps
20+
kind: Deployment
21+
- group: apps
22+
kind: StatefulSet
23+
- group: ''
24+
kind: Service
25+
- group: ''
26+
kind: ConfigMap
27+
- group: ''
28+
kind: Secret
29+
- group: networking.k8s.io
30+
kind: Ingress

‎cli/devopsos.py‎

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import enum
2+
import sys
23
import typer
34
from InquirerPy import inquirer
45
import json
@@ -144,22 +145,33 @@ def scaffold(
144145
tool: str = typer.Option(None, help="Tool type (e.g., github, jenkins, argo, flux)"),
145146
):
146147
"""Scaffold CI/CD or K8s resources."""
147-
if target == "cicd":
148-
scaffold_cicd.main()
149-
elif target == "gha":
150-
scaffold_gha.main()
151-
elif target == "gitlab":
152-
scaffold_gitlab.main()
153-
elif target == "jenkins":
154-
scaffold_jenkins.main()
155-
elif target == "argocd":
156-
scaffold_argocd.main()
157-
elif target == "sre":
158-
scaffold_sre.main()
159-
elif target == "devcontainer":
160-
scaffold_devcontainer.main()
161-
else:
162-
typer.echo("Unknown scaffold target.")
148+
# Each scaffold module uses argparse internally and calls parse_args() which
149+
# reads sys.argv. When invoked via `python -m cli.devopsos scaffold <target>`
150+
# sys.argv still contains the parent CLI tokens (e.g. ['devopsos.py', 'scaffold',
151+
# 'gha']). Temporarily strip those extra tokens so argparse inside each
152+
# scaffold module only sees the program name and falls back to env-var / default
153+
# values, then restore sys.argv afterwards.
154+
_saved_argv = sys.argv[:]
155+
sys.argv = sys.argv[:1]
156+
try:
157+
if target == "cicd":
158+
scaffold_cicd.main()
159+
elif target == "gha":
160+
scaffold_gha.main()
161+
elif target == "gitlab":
162+
scaffold_gitlab.main()
163+
elif target == "jenkins":
164+
scaffold_jenkins.main()
165+
elif target == "argocd":
166+
scaffold_argocd.main()
167+
elif target == "sre":
168+
scaffold_sre.main()
169+
elif target == "devcontainer":
170+
scaffold_devcontainer.main()
171+
else:
172+
typer.echo("Unknown scaffold target.")
173+
finally:
174+
sys.argv = _saved_argv
163175

164176
@app.command("process-first")
165177
def process_first_cmd(

0 commit comments

Comments
 (0)