`נתיב לקובץ התצורה אם סופק. ערך ברירת המחדל הוא pwd/default.env.
- `--docker,-d`הפעל מחדש בדיקות בסביבת docker, עיין [בתכונות נתמכות](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp) כדי לראות איזה כלי/שפה.
- `--verbose,-v`הפעל רישום מפורט (מצב ניפוי שגיאות).
# env. הוראות ליצירת קובץ
**דרך קלה להוריד את קובץ ה-.env היא להשתמש ב- [https://app.roost.ai/gptCLIForm](https://translate.google.com/website?sl=en&tl=he&hl=en&client=webapp&u=https://app.roost.ai/gptCLIForm)**
קובץ ה-.env צריך להיות באותו נתיב תיקייה כמו קובץ הבינארי RoostGPT.
כך ייראה תוכן קובץ ה-.env שלך:
```
```
```
# GIT env vars
GIT_TYPE=github # Default is github; Supports [github, gitlab, azure, bitbucket, local]
HOSTED_TYPE=cloud # Default is cloud; Supports [cloud, hosted]
GIT_HOSTED_URL= # Required if HOSTED_TYPE=hosted
USE_SSH=false # Optional; Default is false; Supports [true, false]; SSH based auth for Git
LOCAL_PROJECT_PATH= # Required if GIT_TYPE is local, Path to your workspace.
SOURCE_GIT_CLONE_URL= # Optional; the source repo clone URL
SOURCE_GIT_TOKEN= # Required
SOURCE_OWNER_NAME= # Required
SOURCE_REPO_NAME= # Required
SOURCE_REPO_ID= # Required for GIT_TYPE=gitlab
SOURCE_PROJECT_NAME= # Required for GIT_TYPE=azure
SOURCE_PROJECT_ID= # Required for GIT_TYPE=bitbucket
SOURCE_BASE_BRANCH= # Required
SOURCE_RELATIVE_DIRECTORY= # Optional; the relative path of the repository
SAME_TARGET_DETAIL=true # Optional; Default true, Supports [true, false]
DESTINATION_GIT_CLONE_URL= # Optional; the destination repo clone URL
DESTINATION_GIT_TOKEN= # Required if SAME_TARGET_DETAIL=false
DESTINATION_OWNER_NAME= # Required if SAME_TARGET_DETAIL=false
DESTINATION_REPO_NAME= # Required if SAME_TARGET_DETAIL=false
DESTINATION_REPO_ID= # Required if SAME_TARGET_DETAIL=false and GIT_TYPE=gitlab
DESTINATION_PROJECT_NAME= # Required for GIT_TYPE=azure
DESTINATION_PROJECT_ID= # Required if SAME_TARGET_DETAIL=false and GIT_TYPE=bitbucket
DESTINATION_BASE_BRANCH= # Required if SAME_TARGET_DETAIL=false
ENABLE_SECRET_SCANNING_BYPASS= # Optional; Default is true; Supports [true, false]
# Open AI env vars
OPENAI_API_MODEL=gpt-4 # Optional; Default is gpt-4
OPENAI_BASE_URL= # Optional; Default is "https://api.openai.com/v1"
OPENAI_API_KEY= # Required if AI_TYPE=openai
# Vertex AI env vars
VERTEX_FINE_TUNE=false # Optional; Default is false, Supports [true, false]
VERTEX_CREDENTIAL_TYPE= # Required if AI_TYPE=vertexai; Supports [file, token]
VERTEX_PROJECT_ID= # Required if AI_TYPE=vertexai
VERTEX_REGION= # Required if AI_TYPE=vertexai and VERTEX_FINE_TUNE=true
VERTEX_BEARER_TOKEN= # Required if AI_TYPE=vertexai and VERTEX_CREDENTIAL_TYPE=token
VERTEX_MODEL= # Required if AI_TYPE=vertexai; Supports [text-bison, code-bison, codechat-bison, text-bison-32k, code-bison-32k, codechat-bison-32k, gemini-pro]
VERTEX_SERVICE_ACCOUNT_KEY= # Required if AI_TYPE=vertexai and VERTEX_CREDENTIAL_TYPE=file; path to the service account key file
# Azure Open AI env vars
AZURE_OPENAI_ENDPOINT= # Required if AI_TYPE=azure_open_ai
AZURE_DEPLOYMENT_NAME= # Required if AI_TYPE=azure_open_ai
AZURE_OPENAI_KEY= # Required if AI_TYPE=azure_open_ai
AZURE_OPENAI_VERSION=2024-02-15-preview # Optional Default is 2024-02-15-preview
AZURE_INFERENCE_AI= # Optional; Default is false; Supports [true, false]
# Open source env vars
OPEN_SOURCE_MODEL_ENDPOINT= # Required if AI_TYPE=open_source_ai
OPEN_SOURCE_MODEL= # Optional; Supports [meta-llama/Llama-2-13b-chat, HuggingFaceH4/starchat-beta]
# Sagemaker model env vars
SAGEMAKER_MODEL_ENDPOINT= # Required if AI_TYPE=sagemake_model
# Claude AI env vars
CLAUDE_AI_MODEL= # Required if AI_TYPE=claude_ai
CLAUDE_AI_API_KEY= # Required if AI_TYPE=claude_ai
# DBRX AI env vars
DBRX_MODEL_ENDPOINT= # Required if AI_TYPE=dbrx
DBRX_AUTH_TOKEN= # Required if AI_TYPE=dbrx
DBRX_MODEL_NAME= # Required if AI_TYPE=dbrx
# AWS Bedrock env vars
AWS_BEDROCK_MODEL= # Required if AI_TYPE=AWS_BEDROCK
AWS_DEFAULT_REGION= # Required if AI_TYPE=AWS_BEDROCK
AWS_ACCESS_KEY_ID= # Optional if AI_TYPE=AWS_BEDROCK
AWS_SECRET_ACCESS_KEY= # Optional if AI_TYPE=AWS_BEDROCK
AWS_SESSION_TOKEN= # Optional if AI_TYPE=AWS_BEDROCK
# Advanced AI env vars
AI_TEMPERATURE=0.2 # Optional; Default value is 0.2
USE_ASSISTANT=false # Optional; Use Assistant feature in openai. Default:false
# Jira board env vars
JIRA_HOST_NAME= # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_EMAIL= # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_TOKEN= # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_ID= # Optional if TEST_TYPE=functional and BOARD_TYPE=jira
# Azure board env vars
AZURE_ORG= # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_PROJECT= # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_TOKEN= # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_WORK_ITEM_ID= # Optional if TEST_TYPE=functional and BOARD_TYPE=azure
# Advanced Jira/Azure board env vars
CREATE_API_SPEC= # Optional; Used for TEST_TYPE=functional
CREATE_EXCEL= # Optional; Default is false; Supports [true, false]
TICKET_INPUT_TYPE= # Optional; Default is id; Supports [id, file]
TICKET_FILES= # Required if TICKET_INPUT_TYPE is file, List of comma separated files
# Log env vars
LOG_SOURCE=elks # Optional; Default is elks
LOG_SOURCE_PATH= # Optional; the log file path
LOG_FILE_ENCODING= # Optional; the log file encodeing; Default is utf-8
LOG_ELASTICSEARCH_URL= # Optional; the Elastic search URL
LOG_ELASTICSEARCH_USER= # Optional; the Elastic search user name
LOG_ELASTICSEARCH_TOKEN= # Optional; the Elastic search token
LOG_ELASTICSEARCH_API_KEY= # Optional; the Elastic search api key
# Behavioural test cases env vars
BEHAVIORAL_TEST_TYPE= # Optional; Supports [gherkin]
BEHAVIORAL_TEST_SOURCE= # Optional; Supports [file, gitpath, url]
BEHAVIORAL_TEST_FILE_PATH= # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath.
BEHAVIORAL_TEST_URL= # Optional; URL of the source file if source is url
# API Spec env vars
API_SPEC_TYPE= # Optional; Supports [swagger, postman, raml]
API_SPEC_SOURCE= # Optional; Supports [file, gitpath, url]
API_SPEC_FILE_PATH= # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath.
API_SPEC_URL= # Optional; URL of the source file if source is url
API_SPEC_ALIAS=
# Proto Spec env cars
PROTO_SPEC_SOURCE= # Optional; Supports [file, gitpath, url, gitrepo]
PROTO_SPEC_FILE_PATH= # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath
PROTO_SPEC_URL= # Optional; URL of the source file if source is url
PROTO_SPEC_GIT_REPO_URL= # Optional; the proto repo clone URL
PROTO_SPEC_GIT_BRANCH= # Required: branch of git repo of proto file
PROTO_SPEC_REPO_NAME= # Required; Repo name of proto file
PROTO_SPEC_REPO_ID= # Required if GIT_TYPE=gitlab
PROTO_SPEC_PROJECT_NAME= # Required for GIT_TYPE=azure
PROTO_SPEC_PROJECT_ID= # Required for GIT_TYPE=bitbucket
API_TEST_SERVER_CONFIG= # Optional; The api server config
# Cypress test env vars
SCREENSHOTS_SOURCE= # Optional; Used for cypress test. Supports [file, gitpath, url]
SCREENSHOTS_URL= # Optional; URL of the source file if source is url
SCREENSHOTS_FILE_PATH= # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath
HTTP_VERBS_FOR_TESTING=get,post,put,patch,delete # Optional; Default is "get,post,put,patch,delete", Supports all the combinations of http verbs. The specific http methods to be tested for all APIs. Enter "," seperated values here.
REGEX_HTTP_ENDPOINTS_FOR_TESTING= # Optional; Regex string that matches to specific endpoints that needs to be tested. If empty, all the endpoints will be tested.
# Application test env vars
APPLICATION_ENTRYPOINT= # Required; if you need to generate application tests along with unit tests. This feature is supported only for GPT Turbo models. Use a relative path from the project root.
# License env vars
ROOST_DOMAIN=app.roost.ai # Optional; Default is app.roost.ai
ROOST_TOKEN= # Optional; the Roost token or license filepath, default $HOME/.roost/license.ral
TELEMETRY=true # Optional; Default is true, Supports [true, false], send telemetry data to roost, no private information is shared.
# Additional env vars
TEST_NAME=roost-test # Optional; Default is roost-test
ROOST_DIR=/var/tmp/Roost/RoostGPT # Optional; Default is /var/tmp/Roost/RoostGPT
LANGUAGE=java # Optional; Default is java; Supports [java, go, python, csharp, nodejs, cpp]
AI_TYPE=openai # Optional; Default is openai; Supports [openai, vertexai, azure_open_ai, open_source_ai, sagemaker_model, claude_ai, dbrx, bedrock_ai, deepseek_ai]
JAVA_BUILD_TOOL=maven # Optional; Default is maven; Supports [maven, gradle]
PACKAGES_TO_SCAN=* # Optional; Default is "*"; used for LANGUAGE=java, for generating tests for specific packages; Enter comma seperated values. E.g. "com.demo.sample,"com.example.products"
ITERATION=1 # Optional; Set VERIFY_TEST=true to enable iteration; Default value of ITERATION is 1
TIMEOUT=1 # Optional; Default is 1 hour
ROOST_USER_INPUT= # Optional; The user input will be used to generate tests.
TEST_TYPE=unit # Optional; Default is unit Supports [unit, functional, artillery, integration, api-spec-test, ui-test, functional-source]
BOARD_TYPE=jira # Optional; Default is jira; Supports [jira, azure, none]
MAX_DEPTH=-1 # Optional; Default is -1; if MAX_DEPTH is -1, it will traverse all the sub directories else the maximum depth directories to look for
TEST_FRAMEWORK= # Optional; Default is "pytest" for Python, "gotest" for Golang, "JUnit4" for Java, "nunit" for CSharp, "jest" for Node.js, "postman" for Postman test-script. Supports [pytest, unittest] for Python, [gotest] for Golang, [JUnit4, JUnit5] for Java, [nunit] for Csharp, [jest] for Node.js, [postman, artillery, rest-assured, karate, playwright] for [test_type: api-spec-test]
FUNCTIONS_TO_TEST= # Optional; List of function names to be tested, separated by comma. Name to be specified as module.[class.]method OR module.function
VERIFY_TEST=false # Optional; Default is false, Supports [true, false]
VULNERABILITY_GEN=false # Optional; Default is false, Supports [true, false]
CUSTOM_TAGS= # Optional; The tags to be attached to test code, so that the test's can run based on tags
CONSIDER_EXISTING_TEST=false # Optional; Default is false, Supports [true, false], used for Java, python, Golang unit test generation, It scans your repository to identify any existing tests for the specified function. If tests are found, it incorporates them into its consideration and generates additional test cases as needed
CREATE_UNIQUE_BRANCH_FOR_REPORT= # Optional; Default is false; Supports [true, false]
ONE_TEST_FILE_PER_SOURCEFILE= # Optional; valid for LANGUAGE=go , if user want to generate a single test file per source file
GRADING_NOTES=
USER_SCENARIOS=
USE_CACHE=
# UI Test vars
BROWSER_USE_HEADLESS=true # Optional; Default is false; Supports [true, false]
URLS_TO_TEST= # Required if TEST_TYPE="ui-test" and TEST_FRAMEWORK="playwright"
# User can provide additional env var starting with "UI_" prefix
UI_LOGIN_TYPE= # Optional; use only if TEST_TYPE="ui-test" and TEST_FRAMEWORK="playwright"
UI_SITE_USERNAME= # Optional; use only if TEST_TYPE="ui-test" and TEST_FRAMEWORK="playwright"
UI_SITE_PASSWORD= # Optional; use only if TEST_TYPE="ui-test" and TEST_FRAMEWORK="playwright" #
# Language version env vars, Used when RoostGPT is run in docker mode, visit https://docs.roost.ai/topics/roostgpt/page/cli to check the supported language versions
JAVA_VERSION=17 # Optional; Default is 17, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
MAVEN_VERSION=3.8.6 # Optional; Default is 3.8.6, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
GRADLE_VERSION=8.6 # Optional; Default is 8.6, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
GO_VERSION=1.19.9 # Optional; Default is 1.19.9, Used for TEST_FRAMEWORK "gotest"
PYTHON_VERSION=3 # Optional; Default is 3, Used for TEST_FRAMEWORK "pytest", "unittest"
DOTNET_VERSION=8 # Optional; Default is 8, Used for TEST_FRAMEWORK "nunit"
NODE_VERSION=18.18.0 # Optional; Default is 18.18.0, Used for TEST_FRAMEWORK "artillery", "postman", "rest-assured", "karate", "jest", "mocha"
KARATE_VERSION=1.5.1 # Optional; Default is 1.5.1, Used for TEST_FRAMEWORK "karate",
```
**הערה**: אם ערך בקובץ ה-.env שלך מכיל את התו '#', הקף את הערך כולו במרכאות. פעולה זו מונעת את פירוש ה-'#' כתחילת הערה.
דוגמה: SECRET\_KEY="my#secret#key"
# פרטים על משתני env
**הנה תיאור של כל משתנה:**
##### **\# משתני סביבת גיט**
- **GIT\_TYPE**
תיאור: מציין את סוג מאגר ה-Git.
ערך ברירת מחדל: "github"
ערכים נתמכים: "github", "gitlab", "azure", "bitbucket", "local"
אופציונלי/נדרש: אופציונלי
- **HOSTED\_TYPE**
תיאור: מציין היכן פלטפורמת Git נגישה.
ערך ברירת מחדל: "cloud"
ערכים נתמכים: "cloud", "hosted"
אופציונלי/נדרש: אופציונלי
- **GIT\_HOSTED\_URL**
תיאור: כתובת ה-URL של פלטפורמת ה-Git המתארחת.
אופציונלי/נדרש: נדרש אם HOSTED\_TYPE הוא "hosted"
- **USE\_SSH**
תיאור: מציין האם להשתמש באימות מבוסס SSH עבור Git.
ערך ברירת מחדל: "false"
ערכים נתמכים: "true", "false"
אופציונלי/נדרש: אופציונלי
- **LOCAL\_PROJECT\_PATH**
תיאור: נתיב לסביבת העבודה שלך.
אופציונלי/נדרש: נדרש אם GIT\_TYPE הוא "מקומי"
- **SOURCE\_GIT\_CLONE\_URL**
תיאור: כתובת URL לשכפול עבור מאגר המקור.
אופציונלי/נדרש: אופציונלי
- **SOURCE\_GIT\_TOKEN**
תיאור: אסימון לאימות מאגר Git המקור הספציפי.
אופציונלי/נדרש: נדרש
- **SOURCE\_OWNER\_NAME**
תיאור: שם בעל מאגר המקור (שם משתמש Git).
אופציונלי/נדרש: נדרש
- **SOURCE\_REPO\_NAME**
תיאור: שם מאגר המקור.
אופציונלי/נדרש: נדרש
- **SOURCE\_REPO\_ID**
תיאור: מזהה של מאגר המקור.
אופציונלי/נדרש: נדרש אם GIT\_TYPE הוא "gitlab"
- **SOURCE\_PROJECT\_NAME**
תיאור: שם פרויקט המקור.
אופציונלי/נדרש: נדרש אם GIT\_TYPE הוא "azure"
- **SOURCE\_PROJECT\_ID**
תיאור: מזהה של פרויקט המקור.
אופציונלי/נדרש: נדרש אם GIT\_TYPE הוא "bitbucket"
- **SOURCE\_BASE\_BRANCH**
תיאור: ענף בסיס לבדיקה במאגר המקור.
אופציונלי/נדרש: נדרש
- **SOURCE\_RELATIVE\_DIRECTORY**
תיאור: נתיב ספרייה יחסית בתוך מאגר המקור.
אופציונלי/נדרש: אופציונלי
- **SAME\_TARGET\_DETAIL**
תיאור: מציין אם פרטי ה-Git של היעד זהים לפרטי ה-Git של המקור.
ערך ברירת מחדל: "true"
ערכים נתמכים: "true", "false"
אופציונלי/נדרש: אופציונלי
- **DESTINATION\_GIT\_CLONE\_URL**
תיאור: כתובת URL לשכפול עבור מאגר היעד.
אופציונלי/נדרש: אופציונלי
- **DESTINATION\_GIT\_TOKEN**
תיאור: אסימון לאימות מאגר ה-Git הספציפי שהוא יעד.
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false"
- **DESTINATION\_OWNER\_NAME**
תיאור: שם בעל מאגר היעד (שם משתמש Git).
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false"
- **DESTINATION\_REPO\_NAME**
תיאור: שם מאגר היעד.
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false"
- **DESTINATION\_REPO\_ID**
תיאור: מזהה של מאגר היעד.
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false" ו-GIT\_TYPE הוא "gitlab"
- **DESTINATION\_PROJECT\_NAME**
תיאור: שם פרויקט היעד.
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false" ו-GIT\_TYPE הוא "azure"
- **DESTINATION\_PROJECT\_ID**
תיאור: מזהה של פרויקט היעד.
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false" ו-GIT\_TYPE הוא "bitbucket"
- **DESTINATION\_BASE\_BRANCH**
תיאור: ענף בסיס שבו יש לדחוף את קוד הבדיקה למאגר היעד.
אופציונלי/נדרש: נדרש אם SAME\_TARGET\_DETAIL הוא "false"
##### **\# פתח משתני סביבת בינה מלאכותית**
- **OPENAI\_API\_MODEL**
תיאור: מציין את סוג מודל ה-API של OpenAI שיש להשתמש בו.
ערך ברירת מחדל: "gpt-4"
ערכים נתמכים: "gpt-4", "gpt-3.5-turbo" וכו'. (זמינות המודלים תלויה ב-OPENAI\_API\_KEY).
אופציונלי/נדרש: אופציונלי
- **OPENAI\_API\_KEY**
תיאור: מפתח ה-API הנדרש לגישה ל-API של OpenAI.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "openai"
**AZURE\_OPENAI\_ENDPOINT**
תיאור: נקודת הקצה של ה-API המשמשת לגישה לשירותי Azure OpenAI.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "azure\_open\_ai"
**
AZURE\_DEPLOYMENT\_NAME**
תיאור: שם פריסת Azure OpenAI שברצונך להשתמש בה.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "azure\_open\_ai"
**
AZURE\_OPENAI\_KEY**
תיאור: מפתח ה-API הנדרש לאימות בקשות ל-Azure OpenAI.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "azure\_open\_ai"
**
AZURE\_OPENAI\_VERSION**
תיאור: מציין את גרסת ה-API של Azure OpenAI שיש להשתמש בו.
ערך ברירת מחדל: "2024-02-15-preview"
אופציונלי/חובה: אופציונלי
- **AWS\_BEDROCK\_MODEL**
תיאור: מציין באיזה מודל סלע יש להשתמש.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "bedrock\_ai"
- **AWS\_DEFAULT\_REGION**
תיאור: אזור AWS של המודל המתארח.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "bedrock\_ai".
- **AWS\_ACCESS\_KEY\_ID** תיאור: אישורי זיהוי מפתח גישה של AWS
אופציונלי/נדרש: אופציונלי. ניתן לייצא לסביבה שבה יפעל Roost Binary
- **AWS\_SECRET\_ACCESS\_KEY** תיאור: אישורי זיהוי מפתח גישה סודי של AWS
אופציונלי/נדרש: אופציונלי. ניתן לייצא לסביבה שבה יפעל Roost Binary
- **AWS\_SESSION\_TOKEN** תיאור: אישורי אסימון סשן של AWS
אופציונלי/נדרש: אופציונלי. ניתן לייצא לסביבה שבה יפעל Roost Binary
- **VERTEX\_FINE\_TUNE**
תיאור: מציין האם כוונון עדין מופעל עבור המודל.
ערך ברירת מחדל: "false"
ערכים נתמכים: "true", "false"
- **VERTEX\_PROJECT\_ID**
תיאור: מזהה פרויקט ה-Vertex שאיתו אתה עובד.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "vertexai"
- **תיאור VERTEX\_REGION** : האזור בו ממוקם פרויקט Vertex. לדוגמה, "us-central1".
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "vertexai" ו-VERTEX\_FINE\_TUNE הוא "true"
- **VERTEX\_BEARER\_TOKEN** תיאור: אסימון ה-bearer המשמש לאימות בקשות ל-API של Vertex.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "vertexai".
- **תיאור VERTEX\_MODEL** : שם מודל הקודקוד שיש להשתמש בו.
ערכים נתמכים: "text-bison", "code-bison"
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "vertexai"
**OPEN\_SOURCE\_MODEL\_ENDPOINT**
תיאור: נקודת הקצה של ה-API המשמשת לגישה למודל הבינה המלאכותית בקוד פתוח.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "open\_source\_ai"
**
מודל\_מקור\_פתוח**
תיאור: שם מודל הבינה המלאכותית בקוד פתוח שברצונך להשתמש בו.
ערכים נתמכים: "meta-llama/Llama-2-13b-chat", "HuggingFaceH4/starchat-beta"
אופציונלי/חובה: אופציונלי
**SAGEMAKER\_MODEL\_ENDPOINT**
תיאור: נקודת הקצה שבה מתארח מודל SageMaker.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "sagemaker\_model"
**CLAUDE\_AI\_MODEL**
תיאור: מציין את סוג מודל הבינה המלאכותית של קלוד שיש להשתמש בו.
ערכים נתמכים: "claude-3-opus-20240229", "claude-3-sonnet-20240229", "claude-3-haiku-20240307"
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "claude\_ai"
**
CLAUDE\_AI\_API\_KEY**
תיאור: מפתח ה-API הנדרש לגישה לממשק ה-API של קלוד AI.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "claude\_ai"
**DBRX\_MODEL\_ENDPOINT**
תיאור: נקודת הקצה שבה מתארח מודל הבינה המלאכותית של DBRX.
אופציונלי/חובה: אופציונלי
**
אסימון DBRX\_AUTH\_TOKEN**
תיאור: אסימון האימות הנדרש לגישה למודל DBRX.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "dbrx"
**
DBRX\_MODEL\_NAME**
תיאור: שם מודל ה-DBRX שברצונך להשתמש בו.
אופציונלי/נדרש: נדרש אם AI\_TYPE הוא "dbrx"
**טמפרטורת בינה מלאכותית**
תיאור: מציין את הגדרת הטמפרטורה עבור תגובות בינה מלאכותית, אשר משפיעה על היצירתיות והשונות של יצירת הבדיקות. ערך גבוה יותר מביא לתוצאות יצירתיות ומגוונות יותר, בעוד שערך נמוך יותר מייצר תגובות דטרמיניסטיות יותר.
ערך ברירת מחדל: 0.6
ערכים נתמכים: כל ערך מספרי, בדרך כלל בין 0.0 ל-1.0.
אופציונלי/חובה: אופציונלי
- **השתמש בעוזר**תיאור: מציין האם להשתמש בתכונת המסייע ב-OpenAI.
ערכים נתמכים: "אמת", "שקר"
אופציונלי/חובה: אופציונלי
##### **\# משתני סביבת לוח Jira**
- **JIRA\_EMAIL**
תיאור: כתובת הדוא"ל המשויכת לחשבון Jira שלך.
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "functional" ו-BOARD\_TYPE הוא "jira"
**
JIRA\_HOST\_NAME**
תיאור: שם המארח של מופע Jira שלך (למשל, jira.company.com).
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "functional" ו-BOARD\_TYPE הוא "jira"
**
סיסמת JIRA**
תיאור: הסיסמה לחשבון Jira שלך.
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "functional" ו-BOARD\_TYPE הוא "jira"
**
JIRA\_ID**
תיאור: מזהה Jira המשויך לחשבונך, משמש לעתים קרובות כמזהה ייחודי.
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "functional" ו-BOARD\_TYPE הוא "jira"
**AZURE\_ORG**
תיאור: הארגון המשויך לחשבון Azure DevOps שלך.
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "פונקציונלי" ו-BOARD\_TYPE הוא "תכלת"
**
אסימון\_AZURE**
תיאור: אסימון הגישה לאימות עם Azure DevOps.
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "פונקציונלי" ו-BOARD\_TYPE הוא "תכלת"
**
פרויקט\_AZURE**
תיאור: שם פרויקט Azure DevOps.
אופציונלי/נדרש: נדרש אם TEST\_TYPE הוא "פונקציונלי" ו-BOARD\_TYPE הוא "תכלת"
- **מזהה\_פריט\_עבודה\_AZURE**
תיאור: המזהה המשויך לפריט העבודה הרלוונטי ב-Azure DevOps.
**צור\_מפרט\_API**
תיאור: משמש לסוג בדיקה פונקציונלית
אופציונלי/נדרש: נדרש אם TEST\_TYPE=functional
**מקור\_לוג**
תיאור: המקור שממנו נוצרים היומנים.
ערך ברירת מחדל: "איילים"
אופציונלי/חובה: אופציונלי
**
נתיב\_מקור\_לוג**
תיאור: מיקום בו מאוחסנים קבצי היומן.
אופציונלי/חובה: אופציונלי
**
LOG\_ELASTICSEARCH\_URL**
תיאור: כתובת ה-URL עבור מופע Elasticsearch.
אופציונלי/חובה: אופציונלי
**
LOG\_ELASTICSEARCH\_USER**
תיאור: שם משתמש לגישה למשאבי Elasticsearch.
אופציונלי/חובה: אופציונלי
**
אסימון חיפוש\_אלסטי LOG\_ELASTICSEARCH**
תיאור: אסימון אימות המשמש לגישה למשאבי Elasticsearch.
אופציונלי/חובה: אופציונלי
**
LOG\_ELASTICSEARCH\_API\_KEY**
תיאור: מפתח API המשמש לאימות ואישור גישה לממשקי API של Elasticsearch.
אופציונלי/חובה: אופציונלי
- **קידוד\_קובץ\_לוג**
תיאור: משמש לקידוד קובץ היומן, ברירת המחדל היא utf-8, תומך ב-\[utf-8, utf-16le\].
אופציונלי/חובה: אופציונלי
**סוג\_מבחן\_התנהגותי**
תיאור: מציין את סוג מבחני ההתנהגות שיש להשתמש בהם.
ערכים נתמכים: "מלפפון חמוץ"
אופציונלי/חובה: אופציונלי
**
מקור\_מבחן\_התנהגותי**
תיאור: מציין את מיקום המקור עבור נתוני בדיקת ההתנהגות.
ערכים נתמכים: "קובץ", "gitpath", "כתובת URL"
אופציונלי/חובה: אופציונלי
**
נתיב\_קובץ\_בדיקת\_התנהגות**
תיאור: נתיב לקובץ המקור אם BEHAVIORAL\_TEST\_SOURCE הוא "file" או "gitpath". עבור "gitpath", זה צריך להיות נתיב יחסי בתוך המאגר.
אופציונלי/חובה: אופציונלי
**
כתובת\_URL\_לבדיקת\_התנהגות**
תיאור: כתובת ה-URL של קובץ המקור אם ה-BEHAVIORAL\_TEST\_SOURCE הוא "url".
אופציונלי/חובה: אופציונלי
**API\_SPEC\_TYPE**
תיאור: מציין את סוג מפרט ה-API שיש להשתמש בו.
ערכים נתמכים: "סוואגר", "דוור"
אופציונלי/חובה: אופציונלי
**
API\_SPEC\_SOURCE**
תיאור: מציין את מיקום המקור עבור נתוני מפרט ה-API.
ערכים נתמכים: "קובץ", "gitpath", "כתובת URL"
אופציונלי/חובה: אופציונלי
**
API\_SPEC\_FILE\_PATH**
תיאור: נתיב לקובץ המקור אם API\_SPEC\_SOURCE הוא "file" או "gitpath". עבור "gitpath", זה צריך להיות נתיב יחסי בתוך המאגר.
אופציונלי/חובה: אופציונלי
**
API\_SPEC\_URL**
תיאור: כתובת ה-URL של קובץ המקור אם API\_SPEC\_SOURCE היא "url".
אופציונלי/חובה: אופציונלי
- **API\_SPEC\_ALIAS:**
אופציונלי/חובה: אופציונלי
**נקודת כניסה לאפליקציה**
תיאור: מציין את הנתיב היחסי של נקודת הכניסה של היישום משורש הפרויקט. תיאור זה משמש כאשר נדרשת יצירת בדיקות יישום בנוסף לבדיקות יחידה.
ערכים נתמכים: כל נתיב יחסי תקף לקובץ או ספרייה של נקודת הכניסה בתוך הפרויקט. נתמך רק עבור דגמי GPT-4-turbo.
אופציונלי/חובה: אופציונלי
**HTTP\_VERBS\_FOR\_TESTING**
תיאור: מציין את שיטות ה-HTTP שיש לבדוק עבור כל ממשקי ה-API. זה מאפשר לך לסנן אילו פעלים (שיטות) של HTTP צריכים להיכלל בבדיקות.
ערך ברירת מחדל: "get, post, put, patch, delete"
ערכים נתמכים: כל שילוב של פעלים של HTTP, מופרדים באמצעות פסיקים (למשל, "get, post, put, patch, delete").
אופציונלי/חובה: אופציונלי
**
REGEX\_HTTP\_ENDPOINTS\_FOR\_TESTING**
תיאור: מחרוזת ביטוי רגולרי המשמשת להתאמת נקודות קצה ספציפיות שיש לבדוק. אם משתנה זה נותר ריק, כל נקודות הקצה ייכללו בבדיקה.
ערכים נתמכים: כל תבנית רגולציה חוקית לסינון נקודות קצה.
אופציונלי/חובה: אופציונלי
**ROOST\_DOMAIN**
תיאור: מציין את דומיין Roost שישמש. תיאור זה מגדיר את כתובת ה-URL הבסיסית עבור שירותי RoostGPT.
ערך ברירת מחדל: "app.roost.ai"
ערכים נתמכים: כל כתובת URL חוקית של דומיין Roost.
אופציונלי/חובה: אופציונלי
**
אסימון\_ROOST**
תיאור: אסימון האימות הנדרש לגישה ל-RoostGPT CLI. אסימון זה נחוץ לאימות ואישור הבקשות שלך ל-RoostGPT.
אופציונלי/נדרש: חובה
**
טלמטריה**
תיאור: קובע האם נתוני טלמטריה נשלחים ל-Roost. נתוני טלמטריה מסייעים בשיפור השירות אך אינם כוללים מידע פרטי.
ערך ברירת מחדל: "אמת"
ערכים נתמכים: "אמת", "שקר"
אופציונלי/חובה: אופציונלי
**שם\_מבחן**
תיאור: השם שהוקצה לבדיקה.
ערך ברירת מחדל: "roost-test"
ערכים נתמכים: כל מחרוזת חוקית.
אופציונלי/חובה: אופציונלי
**
ROOST\_DIR**
תיאור: נתיב הספרייה שבו מאוחסנים קבצי RoostGPT ותצורות.
ערך ברירת מחדל: "/var/tmp/Roost/RoostGPT"
ערכים נתמכים: כל נתיב ספרייה חוקי.
אופציונלי/חובה: אופציונלי
**
שָׂפָה**
תיאור: שפת התכנות של קוד המקור שיש לבדוק.
ערך ברירת מחדל: "ג'אווה"
ערכים נתמכים: "java", "go", "python", "csharp", "node.js"
אופציונלי/חובה: אופציונלי
**
בינה מלאכותית\_סוג**
תיאור: מציין את מודל הבינה המלאכותית המשמש ליצירת בדיקות.
ערך ברירת מחדל: "openai"
ערכים נתמכים: "openai", "vertexai", "open\_source\_ai", "azure\_open\_ai", "sagemaker\_model", "claude\_ai", "dbrx"
אופציונלי/חובה: אופציונלי
- **כלי\_בניית\_JAVA**
תיאור: מציין את כלי הבנייה של ג'אווה שעבורו יש ליצור בדיקה.
ערך ברירת מחדל: "maven"
ערכים נתמכים: "maven", "gradle".
אופציונלי/חובה: אופציונלי
**
חבילות\_לסריקה**
תיאור: מציין את החבילות שיש לסרוק לצורך יצירת בדיקה. תומך בחבילה בודדת או בערכים מופרדים בפסיקים.
ערכים נתמכים: רשימה מופרדת בפסיקים של שמות חבילות (לדוגמה, "com.example.product" או "com.example.product, com.example.controller").
אופציונלי/נדרש: נדרש עבור Java
**
איטרציה**
תיאור: מספר האיטרציות להרצת ושיפור הבדיקות.
ערך ברירת מחדל: "1"
ערכים נתמכים: כל מספר שלם חיובי.
אופציונלי/חובה: אופציונלי
- **פסק זמן**תיאור: משך הזמן שאחריו יצירת הבדיקה תופסק אוטומטית.
ערך ברירת מחדל: "שעה אחת"
ערכים נתמכים: כל מחרוזת משך חוקית (לדוגמה, "30 דקות", "שעתיים").
אופציונלי/חובה: אופציונלי
- **סוג\_בדיקה**תיאור: סוג הבדיקה שיש ליצור.
ערך ברירת מחדל: "יחידה"
ערכים נתמכים: "יחידה", "פונקציונלי", "בדיקת api-spec", "אינטגרציה"
אופציונלי/חובה: אופציונלי
- **מסגרת\_בדיקה**תיאור: מציין את מסגרת הבדיקות שתשמש בה בהתבסס על שפת התכנות וסוג הבדיקה.
ערכים נתמכים:
עבור פייתון: "pytest", "unittest"
עבור גולאנג: "gottest"
עבור ג'אווה: "JUnit4", "JUnit5"
עבור Csharp: "nunit"
עבור Node.js: "jest", "mocha"
עבור בדיקות מפרט API או בדיקות אינטגרציה: "דוור", "ארטילריה", "היה בטוח", "קראטה"
אופציונלי/חובה: אופציונלי
- **
מזהה\_טריגר**
תיאור: מזהה ייחודי עבור טריגרים. משמש להבחנה בין טריגרים מרובים.
ערך ברירת מחדל: חותמת זמן של תקופה
ערכים נתמכים: כל מחרוזת או חותמת זמן ייחודית.
אופציונלי/חובה: אופציונלי
- **סוג\_לוח**תיאור: מציין את סוג הלוח שישמש למעקב.
ערך ברירת מחדל: "ג'ירה"
ערכים נתמכים: "jira", "azure", "none"
אופציונלי/חובה: אופציונלי
- **
עומק מקסימלי**
תיאור: עומק מקסימלי של ספריות לחיפוש קבצי בדיקה. אם מוגדר ל-1-, הוא יעבור על כל ספריות המשנה.
ערכים נתמכים: כל מספר שלם שאינו שלילי או -1.
אופציונלי/חובה: אופציונלי
**
פונקציות לבדיקה**
תיאור: רשימת שמות פונקציות לבדיקה, שצוינו כ-module.\[class.\]method או module.function.
ערכים נתמכים: רשימה מופרדת בפסיקים של שמות פונקציות.
אופציונלי/חובה: אופציונלי
- **השתמש במטמון**
תיאור: השתמש במטמון מקומי כדי ליצור בדיקה. (רק למפתחים)
ערך ברירת מחדל: "שקר"
ערכים נתמכים: "אמת", "שקר".
אופציונלי/חובה: אופציונלי
**
אימות\_בדיקה**
תיאור: מציין האם יש לוודא שהבדיקות שנוצרו פועלות כראוי.
ערכים נתמכים: "אמת", "שקר"
אופציונלי/חובה: אופציונלי
**
פגיעות\_GEN**
תיאור: מציין האם ליצור דוח פגיעות בהתבסס על הבדיקות.
ערכים נתמכים: "אמת", "שקר"
אופציונלי/חובה: אופציונלי
- תיאור: משמש ליצירת בדיקות יחידה ב-Java, Python ו-Golang. הוא סורק את המאגר שלך כדי לזהות בדיקות קיימות עבור הפונקציה שצוינה. אם נמצאות בדיקות, הוא משלב אותן בבחינתו ויוצר.
מקרי בדיקה נוספים לפי הצורך.
ערך ברירת מחדל: "אמת"ערכים נתמכים: "אמת", "שקר"
אופציונלי/חובה: אופציונלי
- תיאור: הערות ציון הן קריטריוני ביקורת המשמשים להערכת ושיפור תגובות שנוצרו על ידי בינה מלאכותית לצורך דיוק ויעילות טובים יותר.
ערך ברירת מחדל: "אמת"ערכים נתמכים: "אמת", "שקר"
אופציונלי/חובה: אופציונלי
- **תגיות\_מותאמות\_למשתמש**
תיאור: התגים שיש לצרף לקוד הבדיקה, כך שהבדיקות יוכלו להריץ אותן על סמך התגים.
אופציונלי/חובה: אופציונלי
- **ROOST\_USER\_INPUT**תיאור: קלט משתמש שישמש ליצירת בדיקות.
ערכים נתמכים: כל מחרוזת קלט חוקית.
אופציונלי/חובה: אופציונלי
##### **\#משתני סביבת בדיקת ממשק משתמש**
- BROWSER\_USE\_HEADLESS
תיאור: כדי לפתוח את הדפדפן במצב ללא חיבור headless בעת הפעלת בדיקת ממשק משתמש
ערכים נתמכים: "true","false"
אופציונלי/נדרש: אופציונלי
- URLS\_TO\_TEST
תיאור: כתובת ה-URL שעבורה RoostGPT צריך ליצור בדיקת playbook.
ערכים נתמכים: כל כתובת URL חוקית של אתר אינטרנט.
אופציונלי/נדרש: נדרש.
\# המשתמש יכול לספק משתנה env נוסף שמתחיל בקידומת "UI\_", כגון UI\_LOGIN\_TYPE, UI\_LOGIN\_EMAIL וכו'.
#####
##### **\# שיפור משתני סביבת הבדיקה**
- **נתיב\_קובץ**תיאור: מיקום הקובץ המכיל את הבדיקה אם המשתנה IMPROVE\_TEST מוגדר כ-"true". קובץ זה ישמש כבסיס לשיפור הבדיקה שנוצרה.
ערכים נתמכים: כל נתיב קובץ חוקי.
אופציונלי/נדרש: נדרש אם IMPROVE\_TEST מוגדר כ-"true".
- **
תוכן\_משתמש**
תיאור: תוכן שסופק על ידי המשתמש לשימוש לשיפור הבדיקה שנוצרה. תוכן זה ישולב בתהליך השיפור.
ערכים נתמכים: כל טקסט או נתונים תקפים שסופקו על ידי המשתמש.
אופציונלי/נדרש: נדרש אם IMPROVE\_TEST מוגדר כ-"true".
**
מבחן בדיקה\_ENDPOINT**
תיאור: נקודת הקצה שיש לשפר כאשר TEST\_TYPE מוגדר ל-"postman". תיאור זה מציין לאיזו נקודת קצה של ה-API יכוון סקריפט הבדיקה של Postman.
ערכים נתמכים: כל כתובת URL חוקית של נקודת קצה של API.
אופציונלי/נדרש: נדרש אם TEST\_TYPE מוגדר כ-"postman".
**גרסת\_JAVA**
תיאור: מציין את גרסת Java שיש להשתמש בה כאשר ה-TEST\_FRAMEWORK הוא "JUnit4", "JUnit5", "karate" או "rest-assured".
ערך ברירת מחדל: "17"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי
- **MAVEN\_VERSION**תיאור: מציין את גרסת Maven שתשמש עבור פרויקטים של Java כאשר TEST\_FRAMEWORK הוא "JUnit4", "JUnit5", "karate" או "rest-assured".
ערך ברירת מחדל: "3.8.6"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי
- **GRADLE\_VERSION**תיאור: מציין את גרסת Gradle שתשמש עבור פרויקטים של Java כאשר TEST\_FRAMEWORK הוא "JUnit4", "JUnit5", "karate" או "rest-assured".
ערך ברירת מחדל: "8.6"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי
- **
GO\_VERSION**
תיאור: מציין את גרסת Go שתשמש כאשר TEST\_FRAMEWORK הוא "gotest".
ערך ברירת מחדל: "1.19.9"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי
תיאור: מציין את גרסת Python שתשמש כאשר TEST\_FRAMEWORK הוא "pytest" או "unittest".
ערך ברירת מחדל: "3"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי
- **
DOTNET\_VERSION**
תיאור: מציין את גרסת .NET שתשמש כאשר ה-TEST\_FRAMEWORK הוא "nunit".
ערך ברירת מחדל: "8"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי
**
NODE\_VERSION**
תיאור: מציין את גרסת Node.js שתשמש כאשר ה-TEST\_FRAMEWORK הוא "artillery", "postman", "rest-assured", "karate", "jest" או "mocha".
ערך ברירת מחדל: "18.18.0"
[ערכים נתמכים](https://docs-roost-ai.translate.goog/topics/trying-roostgpt/page/supported-features?_x_tr_sl=en&_x_tr_tl=he&_x_tr_hl=en&_x_tr_pto=wapp)
אופציונלי/חובה: אופציונלי