qacover

QACOVER - SQL QUERY REAK TEST RESIVATION TEST TEST FOR

Qacover هو مكون لتقييم تغطية بيانات الاختبار فيما يتعلق باستعلامات SQL التي يتم تنفيذها في تطبيق Java أو .NET. يتم قياس التغطية وفقًا لمعيار تغطية SQL الكاملة (SQLFPC) ، وهو متغير من MCDC مصمم خصيصًا لاستعلامات SQL. يحدد المعيار مواقف الاهتمام (عناصر التغطية الاختبار) لاختبار استعلام SQL مقابل قاعدة بيانات الاختبار. يتم تمثيل هذه المواقف كمجموعة من قواعد التغطية . هناك أيضًا خيار لقياس تغطية المسوخ لاستفسارات SQL (معيار SQLMTATTION).

في كل مرة يقوم فيها التطبيق بتنفيذ استعلام ، يعترض Qacover على تنفيذ الاستعلام ، ويقوم بإنشاء وتقييم قواعد التغطية ، ويخزن النتائج في بيئة التنمية المحلية.

في نهاية الاختبارات ، يمكنك الحصول على ملخص وتقارير تفصيلية لتغطية بيانات الاختبار. هذا مثال على التقرير الموجز لجلسة الاختبار:

محتويات

• بداية سريعة
• مثال سيناريو
• مكونات Qacover
  • تبعيات جافا في مافن سنترال
  • .NET Packages in Nuget
• إعدادات
  • ملف تكوين Qacover
  • ملف تكوين P6Spy
  • التكوين لـ .NET
• قطع الأشجار
• الإبلاغ
  • توليد التقارير
  • محتوى التقارير
  • قم بتضمين رمز المصدر
• المساهمة والهندسة المعمارية

بداية سريعة

مثال على جافا:

• أضف qacover-core التبعية إلى pom.xml الخاص بك
• انسخ الملفات
  qacover.properties و spy.properties من مجلد qacover-core إلى جذر مشروعك.
• قم jdbc:sqlite:./target/TestDB.db سلسلة اتصال التطبيق jdbc:p6spy:sqlite:./target/TestDB.db بك وإدراج :p6spy afer jdbc (على سبيل المثال
• قم بتشغيل الاختبارات الخاصة بك وانتظر حتى النهاية.

هذا ينشئ target/qacover/rules التي تحتوي على البيانات الداخلية حول تقييم التغطية. لإنشاء تقرير HTML:

• قم بتنزيل ملف Qacover-Model- المراسل المستقل qacover-model-<VERSION>-report.jar من Maven Central (انتقل إلى الإصدارات ثم تصفح الإصدار المحدد للتنزيل).
• قم بتشغيل هذا الأمر من جذر مساحة العمل الخاصة بك:

  java -jar qacover-model- < VERSION > -report.jar  target/qacover/rules  target/qacover/reports

• افتح index.html الذي ستجده في مجلد target/qacover/reports .

إذا وجدت أن أسماء الفصول ليست هي تلك الموجودة في نقطة التفاعل التي تنفذ الاستعلام ، فستحتاج إلى تعديل التكوين لتضمين بعض الاستثناءات لحزمها (انظر لاحقًا) ، وإزالة المجلد target/qacover وتكرارها مرة أخرى.

مثال سيناريو

يحتوي المجلد مع حزمة الاختبار على QacoverSample على مثال على كيفية استخدام معلومات التغطية لتحسين بيانات الاختبار وحالات الاختبار للكشف عن الأخطاء المخفية. أنه يحتوي على ثلاثة سيناريوهات متسلسلة:

1. تنفيذ حالات الاختبار واترك Qacover لتقييم تغطية الاختبار. تم تصميم بيانات الاختبار لتغطية عدد من حالات الاختبار التي تم تحديدها يدويًا. جميع الاختبارات تمر.
2. استخدم معلومات تغطية الاختبار لتحديد المواقف المكشوفة تلقائيًا لإكمال بيانات الاختبار السابقة وحالات الاختبار. هذا يسمح للكشف عن عيوب خفية.
3. التصحيح النهائي والإصلاح.

مكونات Qacover

تبعيات جافا في مافن سنترال

يتم نشر إصدارات القطع الأثرية Java (Java 8 أو أعلى) في Maven Central بموجب المجموعة io.github.giis-uniovi . هناك نوعان من القطع الأثرية:

• qacover-core : القطع الأثرية الرئيسية لاستخدامها كاعتماد AA في التطبيق الخاص بك (كما هو موضح في البداية السريعة).
• qacover-model : لا يشمل إلا النموذج والفصول للقيام بالإبلاغ وفحص قواعد التغطية. استخدمه إذا كنت بحاجة فقط إلى الوصول إلى قواعد التغطية التي تم إنشاؤها مسبقًا (على سبيل المثال لإنشاء تقارير من البرنامج).

كل واحد منهم لديه جرة أخرى قابلة للتنزيل تتضمن تصفيات إضافية:

• qacover-core UBER JAR. ويشمل جميع التبعيات المطلوبة (باستثناء slf4j ) وهي مظللة (أي إعادة تسميتها في مساحة اسم مختلفة لتجنب تعارضات التبعية):
  • قم بتنزيل Artifact باستخدام مؤهل -uber إذا لم تتمكن لأي سبب من الأسباب كاعتماد في التطبيق الخاص بك (على سبيل المثال للنشر في خادم التطبيق). تحتاج ببساطة إلى وضع الجرة في مكتبة الخادم الخاصة بك وتعيين التكوين لاستخدام Qacover.
  • استخدم uber jar كاعتماد تم إعلانه في pom.xml الخاص بك إذا قمت بتجربة تعارض مع الإصدارات: أضف <qualifier>uber</qualifier> إلى إعلان التبعية.
• qacover-model Standalone Reporter: قم بتنزيل Artifact مع مؤهل -report لإنشاء التقارير من سطر الأوامر كما هو موضح في البداية السريعة.

.NET Packages in Nuget

يتم نشر إصدارات .NET Platform في Nuget. كما هو الحال بالنسبة لـ Java ، هناك حزمتان مختلفتان:

• QACover : الحزمة الرئيسية (NetStandard2.9) لتضمين كمرجع حزمة في تكوين المشروع الخاص بك (على سبيل المثال ملف .csproj إذا كنت تستخدم C#).
• QACoverReport : أداة dotnet (netcore2.0) لإنشاء التقارير من سطر الأوامر: قم بتثبيت الأداة باستخدام dotnet tool install QACoverReport وتنفيذها كأمر QACoverReport <rules folder> <reports folder> .

إعدادات

على Java ، تحتاج إلى وجود ملفين تكوين لتقييم التغطية: qacover.properties و spy.properties وتخصيص برنامج تشغيل JDBC. على .NET ، تحتاج فقط إلى الأول مع بعض التعليمات البرمجية الإضافية لاعتراض الاستعلامات.

ملف تكوين Qacover

Qacover يبحث عن qacover.properties بهذا الترتيب:

• خصائص النظام.
• Application ClassPath.
• المسار الافتراضي حيث يتم تنفيذ التطبيق أو الاختبارات.

تحتوي qacover.properties المتوفرة في وحدة qacover-core لهذا الريبو على تكوين عام مناسب للسيناريوهات المشتركة ، ولكن في بعض الأحيان يجب تخصيصه. راجع الملف للحصول على تفاصيل حول كل معلمة تكوين. بعد ذلك ، نسلط الضوء على أهم المعايير التي تعتبر معايير التضمين والاستبعاد.

عندما ينفذ سطر طريقة في التطبيق الخاص بك استعلام SQL ( نقطة التفاعل ) ، يتم تنفيذ سلسلة من المكالمات لطرق إطارك حتى الوصول إلى طريقة السائق التي تنفذ بالفعل الاستعلام. فيما يلي النقطة التي يتم فيها اكتشاف التنفيذ الفعلي للاستعلام ، ولكن ما نريده هو تحديد نقطة التفاعل في التطبيق. لتحقيق ذلك ، يتحقق Qacover من مكدس المكالمات عند نقطة التنفيذ الفعلي ويستبعد على التوالي كل مكالمة تم إجراؤها في أي حزمة إطارية حتى تحدد نقطة تفاعل قاعدة البيانات في طريقتك.

يستبعد Qacover حزم النظام مثل Java أو System أو P6spy أو Qacover Packages ، ولكن بناءً على الإطار ، يجب عليك تكوين استثناءات إضافية عن طريق تعيين خاصية qacover.stack.exclusions في ملف qacover.properties .

مثال : يحتوي المجلد على it/spring-petclinic-main على عينة نموذجية من Boot Spring. تم الإعلان عن الاستبعاد على النحو التالي:

 qacover.stack.exclusions=org.springframework.,org.hibernate.,com.zaxxer.hikari.,com.sun.,sun.reflect.

هذا يزيل فئات الإطار التي نريد تخطيها لتحديد موقع نقطة التفاعل الموجودة في فئة org.springframework.samples.petclinic.PetclinicIntegrationTests .

ومع ذلك ، في هذه الحالة بالذات ، تكون نقطة التفاعل تحت org.springframework . يجب أن نضيف معلمة الإدراج لضمان أن org.springframework.samples. لم يتم استبعاده:

 qacover.stack.inclusions=org.springframework.samples.

هناك معلمات أخرى لتكوين معايير التضمين للحزم ، ومعايير الاستبعاد لأسماء الفصول أو أسماء الجدول. انظر qacover.properties لمزيد من التفاصيل.

ملف تكوين P6Spy

يحتوي spy.properties المتوفرة في المجلد qacover-core لهذا الريبو على الحد الأدنى من التكوين المطلوب بواسطة P6Spy:

• modulelist=giis.qacover.driver.InterceptorFactory يجب أن يكون موجودًا دائمًا للإشارة إلى النقطة التي يمرر بها p6spy عنصر التحكم إلى Qacover
• أيضًا ، قد تحتاج إلى تكوين التنسيقات لـ Boolean ، يعود تاريخها إلى الأوقات.

راجع ملف spy.properties أو P6Spy documentation لمزيد من التفاصيل.

التكوين لـ .NET

التكوين لمشروع .NET استخدم نفس qacover.properties من Java ، ولكنه لا يستخدم spy.properties . بدلاً من ذلك ، يتطلب بعض الترميز:

• على ado.net: غلاف اتصال ، انظر على سبيل المثال sampledbconnectionwrapper.cs
• على إطار الكيان: سياق مخصص يرث من DbContext ، انظر على سبيل المثال ef2InterceptorContext.cs

قطع الأشجار

يمكن تكوين التسجيل للحزم التي تبدأ بـ giis.qacover. :

• مستوى المعلومات مناسب في معظم الحالات: سجلات الاستعلامات والمعلمات وملخص قصير لنتائج التقييم.
• يعرض مستوى التصحيح تفاصيل حول كيفية قراءة ملفات التكوين واعتراض الاستعلام.

بالإضافة إلى السجلات القياسية ، يتم إنشاء log-* أخرى في مجلد rules لعرض معلومات تصحيح إضافية حول الاستعلامات التي يتم تقييمها ، ومخطط قاعدة البيانات ، وقواعد التغطية.

الإبلاغ

يقوم جيل التقرير بإنشاء مجموعة من ملفات HTML الثابتة في المجلد المحدد ، لتفقد الملخص بسهولة وتفاصيل بيانات التغطية.

توليد التقارير

لإنشاء تقارير لديك ثلاثة خيارات:

• من سطر الأوامر: قم بتنزيل مراسل qacover-model المستقل كما هو موضح في البداية السريعة والتنفيذ:

        java -jar qacover-model- < VERSION > -report.jar  target/qacover/rules  target/qacover/reports

• من برنامج أو اختبار يتضمن qacover-model في classpath:

        new giis . qacover . report . ReportManager (). run ( "target/qacover/rules" , "target/qacover/rules" );

• من دورة حياة Maven: إذا تم الإعلان عن qacover-model على أنها تبعية ، فانتقل طريقة ReportMain باستخدام exec-maven-plugin :

        < plugin >
            < groupId >org.codehaus.mojo</ groupId >
            < artifactId >exec-maven-plugin</ artifactId >
            < version >1.6.0</ version >
            < executions >
                < execution >
                    < id >qacover-report</ id >
                    < phase >post-integration-test</ phase >
                    < goals >
                        < goal >java</ goal >
                    </ goals >
                    < configuration >
                        < classpathScope >test</ classpathScope >
                        < classpath />
                        < mainClass >giis.qacover.report.ReportMain</ mainClass >
                        < arguments >
                            < argument >target/qacover/rules</ argument >
                            < argument >target/qacover/reports</ argument >
                        </ arguments >
                    </ configuration >
                </ execution >
            </ executions >
       </ plugin >

محتوى التقارير

يحتوي ملف index.html على ملخص تغطية بيانات الاختبار لكل فئة:

أين:

• ٪: إجمالي في المئة من التغطية (عدد قواعد التغطية التي تغطيها إجمالي عدد قواعد التغطية الناتجة).
• Qrun: إجمالي عدد تقييمات الاستعلام.
• QCOUNT: عدد الاستعلامات المختلفة التي تم تقييمها.
• Qerror: عدد الاستعلامات التي لم يتم تقييمها لأن بعض الأخطاء.
• الميت: عدد قواعد التغطية المغطاة.
• العد: عدد قواعد التغطية التي تم إنشاؤها.
• خطأ: عدد قواعد التغطية التي لم يتم تقييمها لأن بعض الأخطاء.

يمكن للنقر على كل اسم فئة لعرض تقرير يحتوي على تفاصيل الاستعلامات التي تم تقييمها. يشبه التقرير عن الفصل:

...

يوسع النقر فوق السهم لأسفل بالقرب من تغطية النسبة المئوية عند الاستعلام الذي تم تقييمه تفاصيل كل قاعدة تغطية (مغطاة باللون الأخضر ، المكشوف باللون الأصفر):

• رسالة نصية تشرح موقف الاختبار الذي تمثله قاعدة التغطية. إذا لم تتم تغطية قاعدة التغطية ، فيمكن إضافة اختبار و/أو بيانات الاختبار المناسبة لتغطية ذلك.
• تمثيل SQL لقاعدة التغطية.
• مؤشرات إضافية
  • معرف متسلسل.
  • ميت: عدد المرات التي تمت فيها تغطية قاعدة التغطية.
  • العد: عدد المرات التي تم فيها تنفيذ قاعدة التغطية.
  • الفئة ، النوع ، النوع الفرعي ، الموقع: تصنيف حول المكان الذي تأتي منه قاعدة التغطية.

قم بتضمين رمز المصدر

يحتوي بناء الجملة العام لمولد التقرير على أربعة معلمات (لا يلزم سوى المعلمات الأولى إذا لم تقم بتضمين الكود المصدري للفئات قيد الاختبار):

 <rules-folder> <reports-folder> [<source-folders> [<project-folder>]]

على Java ، إذا كنت ترغب في تضمين الكود المصدري في التقارير ، فيجب عليك تعيين قيمة للمعلمة الثالثة <source-folders> لتضمين قائمة مفصولة بالفاصلة للمسار (المسارات) لتحديد موقع المصادر. على سبيل المثال:

• إذا تم تنفيذ التقارير من جذر مشروع Maven Java ، فقم بتعيين src/main/java .
• إذا كانت تنفيذ التقارير تشكل جذر مشروع Java متعدد الموديل (مشروع الأصل) مع وحدتين ، SET module1/src/main/java,module2/src/main/java .

على .NET ، يجب عليك تعيين قيمة لكل من المعلمات الثالثة والرابعة: <source-folders> و <project-folder> . والسبب هو أن موقع ملفات مصدر .NET لا يتطابق تمامًا مع مساحات الأسماء ، بحيث تخزن قواعد تغطية FPC المسار المطلق لملفات مصدر الفئة التي يجب حلها إلى مسار نسبي قبل توليد الإبلاغ. على سبيل المثال:

• إذا كان تنفيذ التقارير من مجلد حل يحتوي على مشروع ، فقم بتعيين كلا المعلمات على .
• إذا كان تنفيذ التقارير من اختبارات الوحدة في حل يحتوي على مشروع ، فقم بتعيين كلا المعلمات على ../../../.. (لأن الدليل الافتراضي الذي يتم تشغيل الاختبارات هو أربعة مستويات في مجلد الحل)
• إذا كان تنفيذ التقارير من مجلد حل يحتوي على مشروع ، ولكن التقارير التي يتم إنشاؤها داخل حاوية تقوم بتشغيل تطبيق خادم ضمن مجلد /app ، قم بتعيين المعلمات AS . /app (تسمح قيمة /app بحل المسار النسبي لكل ملف مصدر من مجلد المشروع).

المساهمة والهندسة المعمارية

انظر سياسات وإرشادات المساهمة العامة لـ GIIS-uniovi في المساهمة.

الآن نقوم بتضمين بعض المعلومات الفنية الخلفية الإضافية:

يستفيد Qacover من P6Spy لاعتراض مكالمات JDBC ، Tdrules للحصول على مخطط قاعدة البيانات واستدعاء خدمة SQLRules لإنشاء قواعد التغطية. يتم تنفيذ كل شيء في محلي مقابل قاعدة البيانات التي تم تكوينها في سلسلة الاتصال.

يظهر أدناه الهيكل الداخلي لحزم Qacover الرئيسية (البادئة giis.qacover. ) أدناه (يتم حذف البادئات من أجل البساطة):

• الوحدة النمطية core : يحتوي على حزم driver core core.sevices .
• وحدة model : تحتوي على حزم model storage reader report .

هذه هي التبعيات بين الحزم:

 مخطط انسيابي TD
  سائق -> جوهر
  Core -> الخدمات (Core.services)
  الخدمات -> التخزين
  التخزين -> الطراز
  Core -> نموذج
  الخدمات -> النموذج
  تقرير -> القارئ
  تقرير -> النموذج
  القارئ -> النموذج
  القارئ -> التخزين