CHAMPREP QA الأوامر
champrep qa يعمل مع CHAMPREP QA من محطة العمل الخاصة بك: تنشيط المستودعات، وتشغيل عمليات الفحص ومراقبة انتهائها، وتصفية النتائج وتصنيفها، التحقق من بوابة الجودة، وتشغيل بيئات المعاينة، وفتح مساحات عمل IDE السحابية . يعمل نيابة عنك، باستخدام CLIتسجيل الدخول المعتاد الخاص بك. يتحقق QA من دورك في المستودع عند مصدره (CHAMPREPCode أو GitHub أوGitLab Bitbucket) في كل استدعاء، وتُطبق حدود الخطة الخاصة بك.
قبل البدء
Section titled “قبل البدء”- تثبيت CLI و تسجيل الدخول مع
champrep auth login. - يجب أن تتضمن خطتك CHAMPREP QA. قم بربط GitHub GitLabأو Bitbucket في تطبيق الويب الخاص بـ QA أولاً إذا كنت تستخدمهما؛ لا تحتاج مستودعات CHAMPREPالكود إلى اتصال إضافي.
مفاتيح المستودعات ومساحات العمل
Section titled “مفاتيح المستودعات ومساحات العمل”تسمي QA المستودع بمفتاحه، والذي champrep qa repos ls و
champrep qa repos available طباعة:
| المصدر | المفتاح |
|---|---|
| CHAMPREP Code | code:<project-uuid> |
| GitHub | github:<id> |
| GitLab | gitlab:<id> |
| Bitbucket | bitbucket:<workspace>/<slug> |
--workspace يختار مساحة عمل ضمان الجودة (QA) التي سيتم العمل فيها: personal,
organization:<id> أو team:<id>. يحدد مستودعات مساحة العمل التي تراها ومساحة العمل التي تُحمل عليها عملية المسح أو التنشيط أو المعاينة أو مساحة عمل IDE . بدون ذلك، يستخدم QA مساحة العمل الافتراضية الخاصة بك، كما يفعل تطبيق الويب.
الأوامر
Section titled “الأوامر”
المستودعات
Section titled “المستودعات”| الأمر | الغرض |
|---|---|
champrep qa repos ls | سرد المستودعات النشطة في مساحة العمل مع بوابتها وآخر فحص لها. --source code|github|gitlab|bitbucket, --gate passed|failed|not_scanned|scanning, --search, --all (بما في ذلك غير النشطة)، --limit (1-100). |
champrep qa repos available --provider P | سرد المستودعات التي يوفرها لك المصدر وما إذا كان كل منها نشطًا أم لا. |
champrep qa repos activate REPO... | ابدأ تحليل ما يصل إلى 100 مستودع. يُحتسب كل مستودع ضمن حصتك المسموح بها من المستودعات. |
champrep qa repos deactivate REPO... | إيقاف تحليل المستودعات. |
champrep qa repos sync --provider gitlab|bitbucket | قراءة GitLab المشاريع أو مستودعات Bitbucket مرة أخرى من حسابك المتصل. |
champrep qa repos sync code:<uuid> | تحديث رأس الفرع الافتراضي لمشروع CHAMPREPكود واحد. تتم مزامنة مستودعات GitHub تلقائيًا. |
عمليات الفحص
Section titled “عمليات الفحص”| الأمر | الغرض |
|---|---|
champrep qa scan REPO | بدء فحص للفرع الافتراضي، أو --ref BRANCH. --watch (-w) يتبعها حتى النهاية؛ --timeout (افتراضي) 30m) يحد من وقت الانتظار؛ --profile يختار ملف تعريف الفحص عندما تطلب مؤسستك ذلك في كل مرة. |
champrep qa scans ls | سرد عمليات الفحص التي بدأتها، أو عمليات الفحص الخاصة بمستودع (--repo REPO)، أو مساحة العمل (--org). --run queued,running,held,passed,failed,canceled; --limit. |
champrep qa scans show SCAN_ID | عرض عملية مسح: الفرع، الالتزام، حالة التشغيل، البوابة، النتائج الجديدة والمُصححة، الدقائق، أي خطأ أو تعليق. |
يتم تشغيل عمليات فحص مستودعات CHAMPREPCode و GitHub من CLI. يتم تحميل تكلفة الفحص عليك مرة واحدة. عندما يتعامل CHAMPREPCode مع الطلب على أنه CHAMPREP QAفحص خاص به، فإن CLI يذكر ذلك وتتابعه بـ
champrep qa scans ls --repo REPO.
النتائج
Section titled “النتائج”| الأمر | الغرض |
|---|---|
champrep qa findings ls | سرد النتائج، مع عرض النتائج المفتوحة افتراضيًا. عوامل التصفية أدناه. --page, --limit (1-100). |
champrep qa findings show FINDING | عرض نتيجة واحدة حسب المعرّف أو رقم ضمان الجودة، مثل QA-0970: درجة الخطورة، الحالة، القاعدة، CWE، الموقع، المقتطف. |
champrep qa findings dismiss FINDING --reason R | رفض اكتشاف. --comment; --secret-revoked بالنسبة للأسرار. |
champrep qa findings reopen FINDING | التراجع عن رفض أو قبول أو حل: تعود النتيجة إلى «تحتاج إلى تصنيف». |
| التصفية | القيم |
|---|---|
--repo REPO | مستودع واحد؛ وفي حالة عدم تحديده، مساحة العمل بأكملها. |
--severity | critical, high, medium, low, info, unknown (مفصولة بفاصلة) |
--cwe | CWE واحد، مثل 79 أو CWE-79 |
--branch | النتائج الموجودة في هذا الفرع |
--state | detected (يحتاج إلى فرز)، confirmed, dismissed, accepted, resolved، أو all. الإعداد الافتراضي: detected,confirmed |
--type | sast, secret, iac, dependency |
--search | البحث النصي، 3 أحرف أو أكثر |
--mine | النتائج المخصصة لك |
أسباب الفصل هي false_positive, acceptable_risk,
mitigating_control, used_in_tests و not_applicable. يتطلب تجاهل دور «المسؤول» أو أعلى. كما يتطلب تجاهل سر أيضًا
--secret-revoked: تأكد من أن السر قد تم إلغاؤه أو أنه لم يكن صالحًا أبدًا.
بوابات الجودة
Section titled “بوابات الجودة”| الأمر | الغرض |
|---|---|
champrep qa gates status REPO | أظهر ما إذا كان المستودع يجتاز بوابة الجودة على الفرع الافتراضي أم --branch، مع عدد كل شرط وحدده الأقصى. |
gates status يخرج برمز 1 عندما تفشل البوابة، لذا يمكنك استخدامها لـ حماية برنامج نصي أو خطوة نشر.
معاينات
Section titled “معاينات”| الأمر | الغرض |
|---|---|
champrep qa previews ls | أدرج المعاينات الحية الخاصة بك. --ended, --org (مساحة العمل بأكملها)، --repo REPO, --limit. |
champrep qa previews show PREVIEW_ID | اعرض معاينة، وعنوانها، وموعد انتهاء صلاحيتها. |
champrep qa previews create | قم بإنشاء نسخة تجريبية وبدء تشغيلها. يتطلب --provider و --repo owner/name؛ أيضًا --branch, --code-project ID, --port. |
champrep qa previews extend PREVIEW_ID --minutes N | إبقاء المعاينة قيد التشغيل لفترة أطول: من 5 إلى 1440 دقيقة، حتى تاريخ انتهاء صلاحيتها النهائي. |
champrep qa previews stop PREVIEW_ID | أوقف المعاينة. |
بالنسبة إلى CHAMPREP Code، --repo هو مسار المشروع، مثل acme/web.
مساحات عمل IDE
Section titled “مساحات عمل IDE”| الأمر | الغرض |
|---|---|
champrep qa ide ls | أدرج مساحات عمل IDE قيد التشغيل (--ended للمساحات السابقة). --json يستبعد كل مساحة عمل idePath، الذي يحتوي على رمز الجلسة الخاص به. |
champrep qa ide start | ابدأ مساحة عمل على --provider و --repo owner/name (--branch, --work-branch, --code-project)، أو مساحة عمل فارغة باستخدام --scratch. |
champrep qa ide open SESSION_ID | اطبع عنوان مساحة العمل؛ --browser يفتحها. |
champrep qa ide stop SESSION_ID | أوقف مساحة عمل. يتم الاحتفاظ بالتغييرات التي لم يتم إرسالها لفترة من الوقت لاستخدامها في الاستعادة. |
ide open تطبع https://qa.champrep.com/workspaces/<id>. العنوان لا يحمل أي بيانات اعتماد: قم بتسجيل الدخول إلى CHAMPREP QA في المتصفح كالمعتاد.
تنشيط مستودع كودCHAMPREP ومسحه:
champrep qa repos available --provider codechamprep qa repos activate code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --yeschamprep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --ref main --watch --yesراجع النتائج الأكثر خطورة وقم بإلغاء أداة اختبار:
champrep qa findings ls --repo code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --severity critical,highchamprep qa findings ls --cwe 89 --branch mainchamprep qa findings show QA-0970champrep qa findings dismiss QA-0970 --reason used_in_tests --comment "fixture key" --yeschamprep qa findings reopen QA-0970 --yesإيقاف عملية النشر عند فشل البوابة:
champrep qa gates status code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --branch main \ && ./deploy.shقم بمعاينة فرع، ثم افتح IDE عليه:
champrep qa previews create --provider code --repo acme/web --branch feature/login --yeschamprep qa previews extend 6731c0ffee0000000000abcd --minutes 60 --yeschamprep qa ide start --provider code --repo acme/web --branch feature/login --yeschamprep qa ide open 6731c0ffee0000000000beef --browser
التأكيد وكتابة البرامج النصية
Section titled “التأكيد وكتابة البرامج النصية”الأوامر التي تُحدث تغييرًا أو تستهلك رصيدك تطلب الإذن أولاً:
repos activate و deactivate, scan, findings dismiss و reopen,
previews create, extend و stop، و ide start و stop. الإجابة y
على محطة طرفية، أو قم بتمرير --yes (-y) في برنامج نصي. بدون محطة طرفية و بدون --yes يرفض الأمر ولا يغير شيئًا. scan, previews create و ide start تحمل مفتاح التماثل، لذا CLIفإن إعادة المحاولة التلقائية بعد حدوث خطأ في الشبكة لا تؤدي أبدًا إلى بدء محاولتين.
إضافة --json لطباعة ما أعادته QA. يظل رمز الخروج كما هو مع
--json: scan --watch --json تطبع الفحص المنتهي وتخرج 1 عندما يفشل الفحص أو بوابته، gates status --json يُغلق 1 عند فشل البوابة، و
repos activate --json يُغلق 1 عندما تم رفض مستودع. مساحة عمل IDE يتم عرض الإجابات بدون idePath: يحتوي على رمز جلسة عمل مساحة العمل. افتح مساحة عمل باستخدام ide open بدلاً من ذلك.
champrep qa findings ls --severity critical --json | jq -r '.[] | "\(.qaId) \(.title)"'scan --watch تنتهي برمز 1 عندما يفشل الفحص أو تفشل بوابته.
الأخطاء التي قد تظهر لك
Section titled “الأخطاء التي قد تظهر لك”| رسالة | ماذا تفعل |
|---|---|
payment required … (REPOSITORY_ALLOWANCE_EXCEEDED) | تم استنفاد الحصة المخصصة للمستودعات في خطتك. قم بتعطيل مستودع أو أضف سعة في قسم «الفوترةCHAMPREP». رمز الخروج 1. |
not allowed for your role … (SOURCE_ROLE_REQUIRED), (SECURITY_MANAGE_REQUIRED), (ROLE_REQUIRED) | دورك في المصدر أو في مساحة العمل لا يسمح بذلك. يتطلب رفض النتائج وقبولها أن تكون «المسؤول عن الصيانة» أو أعلى. |
needs your web session … (SESSION_REQUIRED), (IMPERSONATION_NOT_ALLOWED) | أنت وحدك، بعد تسجيل الدخول إلى تطبيق الويب QA، يمكنك اتخاذ هذا القرار. |
not available to your account … | لا تتضمن خطتك أو سياسة مؤسستك أوCHAMPREP QA هذه الميزة. |
http 422 … (QA_PROVIDER_NOT_SCANNABLE_YET) | عمليات الفحص لمستودعات GitLab وGitLab Bitbucket غير متاحة بعد. |
not found … (REPO_NOT_FOUND), (SCAN_NOT_FOUND) | المستودع غير نشط في مساحة العمل هذه، أو لا يمكنك فتحه. |
يُغلق كل رفض من الرفضات المذكورة أعلاه برمز 1؛ يوجد حد أقصى لمعدل استخدام البوابة 5. مرفوض repos activate تُظهر كل مستودع مرفوض مع سبب الرفض ثم تنتهي 1؛ بينما تظل المستودعات الأخرى نشطة.