หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

Codiumai Cover Agent มีจุดมุ่งหมายเพื่อช่วยเพิ่มความครอบคลุมของรหัสอย่างมีประสิทธิภาพโดยการสร้างการทดสอบที่ผ่านการรับรองโดยอัตโนมัติเพื่อปรับปรุงชุดทดสอบที่มีอยู่


สารบัญ

  • ข่าวและการอัปเดต
  • ภาพรวม
  • การติดตั้งและการใช้งาน
  • การพัฒนา
  • แผนงาน

ข่าวและการอัปเดต

2024-11-05:

โหมดใหม่ - สแกน repo ทั้งหมด, อัตโนมัติระบุไฟล์ทดสอบ, รวบรวมบริบทอัตโนมัติสำหรับแต่ละไฟล์ทดสอบและขยายชุดทดสอบด้วยการทดสอบใหม่ ดูรายละเอียดเพิ่มเติมที่นี่

หน้าปก

ยินดีต้อนรับสู่ Cover-Agent โครงการที่มุ่งเน้นนี้ใช้ AI Generative เพื่อสร้างและปรับปรุงการสร้างการทดสอบโดยอัตโนมัติ (ปัจจุบันส่วนใหญ่เป็นการทดสอบหน่วย) โดยมีวัตถุประสงค์เพื่อปรับปรุงเวิร์กโฟลว์การพัฒนา ตัวแทนปกสามารถวิ่งผ่านเทอร์มินัลและมีการวางแผนที่จะรวมเข้ากับแพลตฟอร์ม CI ยอดนิยม

เราขอเชิญชวนชุมชนให้ทำงานร่วมกันและช่วยขยายขีดความสามารถของตัวแทนปกต่อไปการพัฒนาอย่างต่อเนื่องเป็นโซลูชันที่ทันสมัยในโดเมนการสร้างหน่วยทดสอบอัตโนมัติ นอกจากนี้เรายังต้องการสร้างแรงบันดาลใจให้นักวิจัยใช้ประโยชน์จากเครื่องมือโอเพนซอร์ซนี้เพื่อสำรวจเทคนิคการทดสอบรุ่นใหม่

ภาพรวม

เครื่องมือนี้เป็นส่วนหนึ่งของชุดยูทิลิตี้ที่กว้างขึ้นที่ออกแบบมาเพื่อสร้างการทดสอบหน่วยสำหรับโครงการซอฟต์แวร์โดยอัตโนมัติ การใช้โมเดล AI Generative Generative ขั้นสูงมีจุดมุ่งหมายเพื่อลดความซับซ้อนและเร่งกระบวนการทดสอบเพื่อให้มั่นใจว่าการพัฒนาซอฟต์แวร์คุณภาพสูง ระบบประกอบด้วยองค์ประกอบหลายอย่าง:

  1. Test Runner: ดำเนินการคำสั่งหรือสคริปต์เพื่อเรียกใช้ชุดทดสอบและสร้างรายงานการครอบคลุมรหัส
  2. ตัวแยกวิเคราะห์ความครอบคลุม: ตรวจสอบความครอบคลุมของรหัสเพิ่มขึ้นเมื่อมีการเพิ่มการทดสอบเพื่อให้มั่นใจว่าการทดสอบใหม่มีส่วนช่วยในการทดสอบโดยรวม
  3. ผู้สร้างพรอมต์: รวบรวมข้อมูลที่จำเป็นจาก codebase และสร้างพรอมต์ที่จะส่งผ่านไปยังรูปแบบภาษาขนาดใหญ่ (LLM)
  4. AI Caller: โต้ตอบกับ LLM เพื่อสร้างการทดสอบตามพรอมต์ที่ให้ไว้

การติดตั้งและการใช้งาน

ความต้องการ

ก่อนที่คุณจะเริ่มตรวจสอบให้แน่ใจว่าคุณมีสิ่งต่อไปนี้:

  • OPENAI_API_KEY SET ในตัวแปรสภาพแวดล้อมของคุณซึ่งจำเป็นสำหรับการโทร OpenAI API
  • เครื่องมือครอบคลุมรหัส: รายงานการครอบคลุมรหัส Cobertura XML เป็นสิ่งจำเป็นสำหรับเครื่องมือในการทำงานอย่างถูกต้อง
    • ตัวอย่างเช่นใน Python หนึ่งสามารถใช้ pytest-cov เพิ่มตัวเลือก --cov-report=xml เมื่อเรียกใช้ pytest
    • หมายเหตุ: เรากำลังทำงานอย่างแข็งขันในการเพิ่มประเภทความคุ้มครองเพิ่มเติม แต่โปรดเปิดการประชาสัมพันธ์และมีส่วนร่วมใน cover_agent/CoverageProcessor.py

หากทำงานโดยตรงจากที่เก็บคุณจะต้องใช้:

  • Python ติดตั้งในระบบของคุณ
  • บทกวีที่ติดตั้งสำหรับการจัดการแพ็คเกจ Python คำแนะนำการติดตั้งสำหรับบทกวีสามารถดูได้ที่ https://python-poetry.org/docs/

รันไทม์แบบสแตนด์อโลน

เอเจนต์หน้าปกสามารถติดตั้งเป็นแพ็คเกจ Python Pip หรือเรียกใช้เป็นปฏิบัติการแบบสแตนด์อโลน

Python Pip

ในการติดตั้งแพ็คเกจ Python Pip โดยตรงผ่าน GitHub เรียกใช้คำสั่งต่อไปนี้: 

pip install git+https://github.com/Codium-ai/cover-agent.git

เป็นไบนารี

ไบนารีสามารถทำงานได้โดยไม่ต้องติดตั้งสภาพแวดล้อม Python ในระบบของคุณ (เช่นภายในคอนเทนเนอร์ Docker ที่ไม่มี Python) คุณสามารถดาวน์โหลดรีลีสสำหรับระบบของคุณได้โดยนำทางไปยังหน้ารุ่นของโครงการ

การตั้งค่าที่เก็บ

เรียกใช้คำสั่งต่อไปนี้เพื่อติดตั้งการอ้างอิงทั้งหมดและเรียกใช้โครงการจากแหล่งที่มา: 

poetry install

รันรหัส

หลังจากดาวน์โหลดไฟล์ปฏิบัติการหรือติดตั้งแพ็คเกจ PIP คุณสามารถเรียกใช้เอเจนต์หน้าปกเพื่อสร้างและตรวจสอบความถูกต้องของการทดสอบหน่วย ดำเนินการจากบรรทัดคำสั่งโดยใช้คำสั่งต่อไปนี้: 

cover-agent 
  --source-file-path " <path_to_source_file> " 
  --test-file-path " <path_to_test_file> " 
  --project-root " <path_to_project_root> " 
  --code-coverage-report-path " <path_to_coverage_report> " 
  --test-command " <test_command_to_run> " 
  --test-command-dir " <directory_to_run_test_command> " 
  --coverage-type " <type_of_coverage_report> " 
  --desired-coverage < desired_coverage_between_0_and_ 100> 
  --max-iterations < max_number_of_llm_iterations > 
  --included-files " <optional_list_of_files_to_include> "

คุณสามารถใช้รหัสตัวอย่างด้านล่างเพื่อลองใช้ตัวแทนปก (โปรดทราบว่าไฟล์ usage_examples ให้ตัวอย่างที่ซับซ้อนมากขึ้นเกี่ยวกับวิธีการใช้ตัวแทนปก)

งูหลาม

ทำตามขั้นตอนในไฟล์ readme.md ที่อยู่ใน templated_tests/python_fastapi/ ไดเรกทอรีเพื่อตั้งค่าสภาพแวดล้อมจากนั้นกลับไปที่รูทของที่เก็บและเรียกใช้คำสั่งต่อไปนี้เพื่อเพิ่มการทดสอบในตัวอย่าง Python fastapi : 

cover-agent 
  --source-file-path " templated_tests/python_fastapi/app.py " 
  --test-file-path " templated_tests/python_fastapi/test_app.py " 
  --project-root " templated_tests/python_fastapi " 
  --code-coverage-report-path " templated_tests/python_fastapi/coverage.xml " 
  --test-command " pytest --cov=. --cov-report=xml --cov-report=term " 
  --test-command-dir " templated_tests/python_fastapi " 
  --coverage-type " cobertura " 
  --desired-coverage 70 
  --max-iterations 10

ไป

ตัวอย่างเช่นการใช้ GO cd ใน templated_tests/go_webservice ตั้งค่าโครงการตาม README.md ในการทำงานกับการรายงานความครอบคลุมคุณต้องติดตั้ง gocov และ gocov-xml เรียกใช้คำสั่งต่อไปนี้เพื่อติดตั้งเครื่องมือเหล่านี้: 

go install github.com/axw/gocov/[email protected]
go install github.com/AlekSi/[email protected]

จากนั้นเรียกใช้คำสั่งต่อไปนี้: 

cover-agent 
  --source-file-path " app.go " 
  --test-file-path " app_test.go " 
  --code-coverage-report-path " coverage.xml " 
  --test-command " go test -coverprofile=coverage.out && gocov convert coverage.out | gocov-xml > coverage.xml " 
  --test-command-dir $( pwd ) 
  --coverage-type " cobertura " 
  --desired-coverage 70 
  --max-iterations 1

ชวา

ตัวอย่างเช่นการใช้ Java cd ใน templated_tests/java_gradle ตั้งค่าโครงการตาม readme.md ในการทำงานกับการรายงานความครอบคลุมของ Jacoco ให้ทำตามส่วนข้อกำหนดของ readme.md: จากนั้นเรียกใช้คำสั่งต่อไปนี้: 

cover-agent 
  --source-file-path= " src/main/java/com/davidparry/cover/SimpleMathOperations.java " 
  --test-file-path= " src/test/groovy/com/davidparry/cover/SimpleMathOperationsSpec.groovy " 
  --code-coverage-report-path= " build/reports/jacoco/test/jacocoTestReport.csv " 
  --test-command= " ./gradlew clean test jacocoTestReport " 
  --test-command-dir= $( pwd ) 
  --coverage-type= " jacoco " 
  --desired-coverage=70 
  --max-iterations=1

เอาต์พุต

ไฟล์ดีบั๊กบางไฟล์จะถูกส่งออกภายในพื้นที่เก็บข้อมูล (ซึ่งเป็นส่วนหนึ่งของ .gitignore )

  • run.log : สำเนาของเครื่องบันทึกที่ถูกทิ้งไปยัง stdout ของคุณ
  • test_results.html : ตารางผลลัพธ์ที่มีสิ่งต่อไปนี้สำหรับการทดสอบที่สร้างขึ้นแต่ละครั้ง:
    • สถานะทดสอบ
    • เหตุผลที่ล้มเหลว (ถ้ามี)
    • รหัสออก
    • stderr
    • stdout
    • การทดสอบที่สร้างขึ้น

การบันทึกเพิ่มเติม

หากคุณตั้งค่าตัวแปรสภาพแวดล้อม WANDB_API_KEY การแจ้งเตือนการตอบสนองและข้อมูลเพิ่มเติมจะถูกบันทึกไว้ในน้ำหนักและอคติ

ใช้ LLM อื่น ๆ

โครงการนี้ใช้ Litellm เพื่อสื่อสารกับ OpenAI และ LLM ที่โฮสต์อื่น ๆ (รองรับ 100+ LLMs จนถึงปัจจุบัน) หากต้องการใช้โมเดลอื่นนอกเหนือจากค่าเริ่มต้น OpenAI คุณจะต้อง:

  1. ส่งออกตัวแปรสภาพแวดล้อมใด ๆ ที่ต้องการโดย LLM ที่รองรับตามคำแนะนำ Litellm
  2. โทรหาชื่อของโมเดลโดยใช้ตัวเลือก --model เมื่อเรียกตัวแทนปก

ตัวอย่างเช่น (ตามที่พบในคู่มือเริ่มต้นด่วน Litellm): 

 export VERTEX_PROJECT= " hardy-project "
export VERTEX_LOCATION= " us-west "

cover-agent 
  ...
  --model " vertex_ai/gemini-pro "

ปลายทางที่เข้ากันได้ของ OpenAI 

 export OPENAI_API_KEY= " <your api key> " # If <your-api-base> requires an API KEY, set this value.

cover-agent 
  ...
  --model " openai/<your model name> " 
  --api-base " <your-api-base> "

จุดสิ้นสุดที่เข้ากันได้ของ Azure Openai 

 export AZURE_API_BASE= " <your api base> " # azure api base
export AZURE_API_VERSION= " <your api version> " # azure api version (optional)
export AZURE_API_KEY= " <your api key> " # azure api key

cover-agent 
  ...
  --model " azure/<your deployment name> "

การพัฒนา

ดูการพัฒนาข้อมูลเพิ่มเติมเกี่ยวกับวิธีการมีส่วนร่วมในโครงการนี้

แผนงาน

ด้านล่างนี้เป็นแผนงานของคุณสมบัติที่วางแผนไว้โดยมีสถานะการใช้งานปัจจุบัน:

  • สร้างการทดสอบหน่วยโดยอัตโนมัติสำหรับโครงการซอฟต์แวร์ของคุณโดยใช้โมเดล AI ขั้นสูงเพื่อให้แน่ใจว่าครอบคลุมการทดสอบที่ครอบคลุมและการประกันคุณภาพ (คล้ายกับเมตา)
    • ความสามารถในการสร้างการทดสอบสำหรับภาษาการเขียนโปรแกรมที่แตกต่างกัน
    • ความสามารถในการจัดการกับสถานการณ์การทดสอบที่หลากหลาย
    • สร้างการวิเคราะห์พฤติกรรมสำหรับรหัสภายใต้การทดสอบและสร้างการทดสอบตามนั้น
    • ตรวจสอบการทดสอบความไม่มั่นคงเช่นการวิ่ง 5 ครั้งตามที่แนะนำโดย TestGen-LLM
  • ครอบคลุมความเจ็บปวดในการสร้างการทดสอบมากขึ้น
    • สร้างการทดสอบใหม่ที่มุ่งเน้นไปที่ชุดการเปลี่ยนแปลง PR
    • รันผ่าน repo/code-base ทั้งหมดและพยายามปรับปรุงชุดทดสอบที่มีอยู่ทั้งหมด
  • ปรับปรุงการใช้งาน
    • ตัวเชื่อมต่อสำหรับการกระทำของ GitHub, Jenkins, Circleci, Travis CI และอื่น ๆ
    • รวมเข้ากับฐานข้อมูล, API, opentelemetry และแหล่งข้อมูลอื่น ๆ เพื่อแยก I/O ที่เกี่ยวข้องสำหรับการสร้างการทดสอบ
    • เพิ่มไฟล์การตั้งค่า

Qodoai

ภารกิจของ Qodoai คือการเปิดใช้งานทีม Dev ที่ยุ่งเพื่อเพิ่มและรักษาความสมบูรณ์ของรหัส เรานำเสนอเครื่องมือต่าง ๆ รวมถึงเครื่องมือโอเพนซอร์ซเวอร์ชัน "โปร" ซึ่งมีไว้เพื่อจัดการกับความซับซ้อนของรหัสระดับองค์กร

ลองใช้ Cover Agent รุ่น Pro, Qodo Cover!

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด