Ir al contenido
Documentation

CHAMPREP QA comandos

champrep qa funciona con CHAMPREP QA desde su terminal: active repositorios, ejecute análisis y supervise su finalización, filtre y clasifique los hallazgos, verifique un control de calidad, inicie entornos de vista previa y abra espacios de trabajo de IDE en la nube . Actúa en su nombre, con su CLIinicio de sesión habitual. QA comprueba su rol en el repositorio en su origen (CHAMPREPCode, GitHub oGitLab Bitbucket) en cada llamada, y se aplican los límites de su plan.

  1. Instale el CLI y iniciar sesión con champrep auth login.
  2. Su plan debe incluir CHAMPREP QA. Conecte GitHub, GitLab o Bitbucket en la aplicación web de QA primero si los utiliza; los repositorios de códigoCHAMPREP no necesitan ninguna conexión adicional.

QA identifica un repositorio por su clave, que champrep qa repos ls y champrep qa repos available imprimir:

FuenteClave
CHAMPREP Codecode:<project-uuid>
GitHubgithub:<id>
GitLabgitlab:<id>
Bitbucketbitbucket:<workspace>/<slug>

--workspace selecciona el espacio de trabajo de control de calidad en el que se va a actuar: personal, organization:<id> o team:<id>. Determina qué repositorios del espacio de trabajo se muestran y a qué espacio de trabajo se asigna un análisis, una activación, una vista previa o un espacio de trabajo del IDE. Sin ello, QA utiliza su espacio de trabajo predeterminado, al igual que lo hace la aplicación web.

ComandoObjetivo
champrep qa repos lsMuestre una lista de los repositorios activos del espacio de trabajo con su puerta de control y su último análisis. --source code|github|gitlab|bitbucket, --gate passed|failed|not_scanned|scanning, --search, --all (también inactivos), --limit (1-100).
champrep qa repos available --provider PMuestre la lista de repositorios que le ofrece una fuente e indique si cada uno de ellos está activo.
champrep qa repos activate REPO...Comience a analizar hasta 100 repositorios. Cada uno de ellos cuenta para su límite de repositorios.
champrep qa repos deactivate REPO...Detener el análisis de los repositorios.
champrep qa repos sync --provider gitlab|bitbucketVuelva a leer los GitLabproyectos o repositorios de Bitbucket desde su cuenta conectada.
champrep qa repos sync code:<uuid>Actualizar la punta de la rama predeterminada de un proyecto de códigoCHAMPREP. Los repositorios de GitHub se sincronizan automáticamente.

ComandoObjetivo
champrep qa scan REPOIniciar un análisis de la rama predeterminada, o --ref BRANCH. --watch (-w) lo sigue hasta el final; --timeout (por defecto 30m) limita la espera; --profile selecciona un perfil de análisis cada vez que su organización lo solicite.
champrep qa scans lsMostrar los análisis que ha iniciado, los de un repositorio (--repo REPO), o del espacio de trabajo (--org). --run queued,running,held,passed,failed,canceled; --limit.
champrep qa scans show SCAN_IDMostrar un análisis: rama, confirmación, estado de ejecución, puerta de control, hallazgos nuevos y corregidos, minutos, cualquier error o retención.

Los análisis de CodeCHAMPREP y de los repositorios de GitHub se ejecutan desde el CLI. Se le cobra una sola vez por cada análisis. Cuando CHAMPREPCode gestiona la solicitud como si fuera su propia CHAMPREP QAcomprobación, el sistema lo CLIindica y usted debe continuar con champrep qa scans ls --repo REPO.

ComandoObjetivo
champrep qa findings lsMostrar hallazgos; por defecto, los que están abiertos. Filtros a continuación. --page, --limit (1-100).
champrep qa findings show FINDINGMostrar un hallazgo por ID o número de control de calidad, como QA-0970: gravedad, estado, regla, CWE, ubicación, fragmento de código.
champrep qa findings dismiss FINDING --reason RDescartar un hallazgo. --comment; --secret-revoked para secretos.
champrep qa findings reopen FINDINGDeshacer un rechazo, una aceptación o una resolución: el hallazgo vuelve a «Necesita clasificación».
FiltroValores
--repo REPOUn repositorio; en su defecto, todo el espacio de trabajo.
--severitycritical, high, medium, low, info, unknown (separados por comas)
--cweUn CWE, como 79 o CWE-79
--branchHallazgos en esta rama
--statedetected (Requiere evaluación), confirmed, dismissed, accepted, resolved, o all. Por defecto: detected,confirmed
--typesast, secret, iac, dependency
--searchBúsqueda de texto, 3 caracteres o más
--mineHallazgos que se le han asignado

Los motivos de despido son false_positive, acceptable_risk, mitigating_control, used_in_tests y not_applicable. Para descartar se requiere el rol de «Mantenedor» o superior. Para descartar un secreto también se requiere --secret-revoked: confirme que el secreto ha sido revocado o que nunca fue válido.

ComandoObjetivo
champrep qa gates status REPOMuestre si el repositorio supera el control de calidad en la rama predeterminada o --branch, con el recuento y el límite de cada condición.

gates status termina con el código 1 cuando la puerta de control falla, por lo que puede utilizarla para proteger un script o un paso de implementación.

ComandoObjetivo
champrep qa previews lsMuestre una lista de sus vistas previas en tiempo real. --ended, --org (todo el espacio de trabajo), --repo REPO, --limit.
champrep qa previews show PREVIEW_IDMuestre una vista previa, su dirección y cuándo caduca.
champrep qa previews createCompile e inicie una vista previa. Requiere --provider y --repo owner/name; también --branch, --code-project ID, --port.
champrep qa previews extend PREVIEW_ID --minutes NMantenga una vista previa en ejecución durante más tiempo: de 5 a 1440 minutos, hasta su caducidad definitiva.
champrep qa previews stop PREVIEW_IDDetenga una vista previa.

Para CHAMPREP Código, --repo es la ruta del proyecto, como por ejemplo acme/web.

ComandoObjetivo
champrep qa ide lsMuestre una lista de sus espacios de trabajo del IDE en ejecución (--ended (para los anteriores). --json Omite el token de cada espacio de trabajo idePath, que contiene su token de sesión.
champrep qa ide startInicie un espacio de trabajo en --provider y --repo owner/name (--branch, --work-branch, --code-project), o uno vacío con --scratch.
champrep qa ide open SESSION_IDImprima la dirección del espacio de trabajo; --browser lo abre.
champrep qa ide stop SESSION_IDDetenga un espacio de trabajo. Los cambios que no se hayan enviado se conservan durante un tiempo para su recuperación.

ide open imprime https://qa.champrep.com/workspaces/<id>. La dirección no contiene credenciales: inicie sesión en CHAMPREP QA en el navegador como de costumbre.

Active un repositorio de códigoCHAMPREP y analícelo:

Ventana de terminal
champrep qa repos available --provider code
champrep qa repos activate code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --yes
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --ref main --watch --yes

Revise los hallazgos más graves y descarte un caso de prueba:

Ventana de terminal
champrep qa findings ls --repo code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --severity critical,high
champrep qa findings ls --cwe 89 --branch main
champrep qa findings show QA-0970
champrep qa findings dismiss QA-0970 --reason used_in_tests --comment "fixture key" --yes
champrep qa findings reopen QA-0970 --yes

Detener una implementación cuando falle la puerta de enlace:

Ventana de terminal
champrep qa gates status code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --branch main \
&& ./deploy.sh

Obtenga una vista previa de una rama y, a continuación, abra un IDE en ella:

Ventana de terminal
champrep qa previews create --provider code --repo acme/web --branch feature/login --yes
champrep qa previews extend 6731c0ffee0000000000abcd --minutes 60 --yes
champrep qa ide start --provider code --repo acme/web --branch feature/login --yes
champrep qa ide open 6731c0ffee0000000000beef --browser

Los comandos que modifican algo o consumen su asignación le preguntarán primero: repos activate y deactivate, scan, findings dismiss y reopen, previews create, extend y stop, y ide start y stop. Respuesta y en un terminal, o introduzca --yes (-y) en un script. Sin terminal y sin --yes El comando devuelve un «rechazado» y no modifica nada. scan, previews create y ide start incluyen una clave de idempotencia, por lo CLIque el reintento automático tras un error de red nunca inicia dos.

Añadir --json para mostrar lo que ha devuelto QA. El código de salida sigue siendo el mismo con --json: scan --watch --json muestra el análisis finalizado y finaliza 1 Cuando el escaneo o su puerta de enlace falla, gates status --json termina 1 en una puerta de enlace con fallo, y repos activate --json termina 1 cuando se ha rechazado un repositorio. Espacio de trabajo del IDE las respuestas se muestran sin idePath: contiene el token de sesión del espacio de trabajo. Abra un espacio de trabajo con ide open en su lugar.

Ventana de terminal
champrep qa findings ls --severity critical --json | jq -r '.[] | "\(.qaId) \(.title)"'

scan --watch termina con el código 1 cuando falla el análisis o falla su puerta de enlace.

MensajeQué hacer
payment required … (REPOSITORY_ALLOWANCE_EXCEEDED)Se ha agotado el límite de repositorios de su plan. Desactive un repositorio o amplíe la capacidad en «FacturaciónCHAMPREP». Código de salida 1.
not allowed for your role … (SOURCE_ROLE_REQUIRED), (SECURITY_MANAGE_REQUIRED), (ROLE_REQUIRED)Su rol en la fuente o en el espacio de trabajo no se lo permite. Para descartar y aceptar hallazgos se requiere el rol de «Mantenedor» o superior.
needs your web session … (SESSION_REQUIRED), (IMPERSONATION_NOT_ALLOWED)Solo usted, una vez que haya iniciado sesión en la aplicación web de control de calidad, puede tomar esta decisión.
not available to your account …Su plan o la política de su organización no incluyeCHAMPREP QA esta función.
http 422 … (QA_PROVIDER_NOT_SCANNABLE_YET)Los análisis de los repositorios de GitLab yGitLab Bitbucket aún no están disponibles.
not found … (REPO_NOT_FOUND), (SCAN_NOT_FOUND)El repositorio no está activo en este espacio de trabajo, o no puede abrirlo.

Cada rechazo de los anteriores finaliza con el código 1; existe un límite de velocidad en la pasarela 5. Un rechazo repos activate muestra cada repositorio rechazado con su motivo y termina 1; las demás siguen activadas.