JiraTestResultReporter (2023)

Hallo! Takk for at du er interessert i å bidra til denne plugin! Hvis du lette etter de tidligere versjonene, vennligst sjekk 1.x-grenen

Hvordan sende inn en feilrapport/funksjonsforespørsel

For å sende inn feilrapporter og funksjonsforespørsler vennligst bruk den offisielleJIRAfor Jenkins og spesifiser i komponentfeltetjiratestresultreporter-plugin.

I tilfelle feilrapporter, vennligst spesifiser:

• plugin-versjonen
• Jenkins-versjonen
• trinnvise instruksjoner for hvordan du reproduserer feilen
• resultatet slik du ser det
• hva tror du det forventede resultatet bør være.

I tilfelle funksjonsforespørsler, beskriv i detalj hva du vil at denne plugin-en skal gjøre, og spesifiser om mulig brukssaken for den, slik at du er sikker på at den dekkes av en eventuell implementering.

Hvordan bidra

Bidrag for denne plugin-en bør være i form av pull-forespørsler.

Før du gir et bidrag, sørg for at det er en JIRA-billett for feilen du fikser, eller for funksjonen du implementerer som spesifisert ovenfor. I noen trivielle tilfeller, som å rydde opp, refaktorere, fikse skrivefeil, er det ikke behov for et JIRA-problem.

Én pull-forespørsel skal løse én JIRA-billett.

For enkelhets skyld bør du prøve å bruke følgende arbeidsflyt:

Sett opp arbeidsflyt

• Fork på GitHub (klikk på Fork-knappen)
• Klon til datamaskin, bruk SSH URL ($ git clonegit@github.com:${your_git_username}/JiraTestResultReporter-plugin.git)
• cd inn i repoen din: ($ cd JiraTestResultReporter-plugin/)
• Sett opp ekstern oppstrøms ($ git remote add upstreamgit@github.com:jenkinsci/JiraTestResultReporter-plugin.git)

Rette en feil/implementere en funksjonsarbeidsflyt

• Opprett en filial for JIRA-problemet du løser ($ git checkout -b issue/JENKINS-XXXXXX)
• Utvikle på problem gren. [Tiden går, hovedlageret akkumulerer nye forpliktelser]
• Forplikte endringer til din lokale utstedelsesavdeling. ($ git add . ; git commit -m 'JENKINS-XXXXXX - commit message')
• Hent oppstrøms ($ git hente oppstrøms)
• Oppdater lokal master ($ git checkout master; git merge upstream/master)
• Rebase issue branch ($ git checkout issue/JENKINS-XXXXXX; git rebase master)
• Gjenta trinnene ovenfor til dev er fullført
• Skyv gren til GitHub ($ git push)
• Start nettleseren din, gå til Github-repoen din, bytt til "JENKINS-XXXXXX"-grenen og trykk på [Pull Request]-knappen.

Vennligst hold PR-ene så rene som mulig ved å ikke blande to eller flere problemer i en enkelt PR, eller refaktorerer/rydde opp/skrivefeil med å løse problemet. Hvis du kan ha funksjonsimplementeringen i en enkelt git-commit, er det enda bedre. Hvis du har delt opp arbeidet ditt i mange forpliktelser, kan du slå dem sammen i en enkelt etterpå, hvis det gir mening.

I alle fall bør hver forpliktelse være fullt funksjonell. Som spesifisert i arbeidsflyten skal filialnavnet og hver commit-melding inneholde problemnøkkelen. Vi ville elske det om du også kunne gi tester for problemet ditt i PR (selv om vi ikke har noen ennå :) ).

ADVARSEL: 2.x-versjoner av denne plugin-en er ikke kompatible med den forrige 1.x-versjonen. Hva dette betyr er at konfigurasjonene dine knyttet til denne plugin ikke vil bli importert fra tidligere versjoner når du gjør en oppgradering.

Hva er gjør

Dette pluginet lar deg opprette og/eller koble problemer fra Jira til mislykkede tester i Jenkins. Opprettelsen/koblingen gjøres direkte i Jenkins-grensesnittet. For opprettelse av utgavene kan du oppgi en mal for hva som skal legges til i de fleste av utgavens felt.

Global konfigurasjon

Før du gjør noe annet, må de globale konfigurasjonene gjøres. For å gjøre disse gå tilAdministrer Jenkins -> Konfigurer system -> JiraTestResultReporterog her skriv inn JIRA server url brukernavn og passord. Det anbefales sterkt at du klikker på knappen Valider innstillinger hver gang du gjør endringer her. Herfra kan du også konfigurere de globale malene for Sammendrag og Beskrivelse, ved å klikke på Avansert-knappen. Disse malene vil bli brukt til å lage problemer hvis de ikke overstyres i jobbkonfigurasjonen.

Jobbkonfigurasjon

Pipeline stil jobber

Du kan se nedenfor og eksempel på en rørledningsbruk.

Det du må huske på er at du må bruke feltnøklene og verdiene slik de er definert i REST API. For eksempel, for 'issueType', forventer API-en IDen for problemtypen, i dette tilfellet '1', i stedet for 'Bug'.

junit(testresultater:'**/surefire-reports/*.xml',testDataPublishers: [jiraTestResultReporter(konfigurasjoner: [jiraStringField(feltnøkkel:'sammendrag',verdi:'${DEFAULT_SUMMARY}'),jiraStringField(feltnøkkel:'beskrivelse',verdi:'${DEFAULT_DESCRIPTION}'),jiraStringArrayField(feltnøkkel:"etiketter",verdier: [existsArrayEntry(verdi:'Jenkins'),existsArrayEntry(verdi:'Integrering')]) ],prosjektnøkkel:'J2J',issueType:'1',autoRaiseIssue:falsk,autoResolveIssue:falsk,autoUnlinkIssue:falsk, ) ])

Klassiske jobber

Det første vi må gjøre her er å aktivere plugin:

• Freestyle-prosjekterogMultikonfigurasjonsprosjekter

  Først må JUnit-testrapporter aktiveres ved å gå tilLegg til handling etter bygging -> Publiser JUnit-testrapport. Merk deretter av i boksen ved siden avJiraTestResultReporteriYtterligere testrapportfunksjoner.

• Maven-prosjektet

  Legg til handling etter bygging -> Ytterligere testrapportfunksjoner-> merk av i boksen ved siden avJiraTestResultReporter.

Konfigurasjon:

Sett innProsjektnøkkeli det respektive feltet. Igjen, sterkt anbefalt å trykke på Validate Settings.

Etter å ha satt prosjektnøkkelen tilProblemtypeselect vil fylles ut med de tilgjengelige problemtypene for det spesifikke prosjektet.

Hvis du sjekkerAuto heve problemavkrysningsboksen, vil denne plugin-en opprette og koble sammen problemer for alle de mislykkede testene i nye bygg som ikke allerede har koblede problemer.

SjekkerAutomatisk løsning av problemetavmerkingsboksen vil aktivere en eksperimentell funksjon. I utgangspunktet, hvis du hadde en test som mislyktes og du hadde et knyttet Jira-problem til den, vil plugin-en prøve å løse problemet. Hva dette betyr er at den vil se etter tilgjengelige overganger fra den nåværende tilstanden, og den vil prøve å finne en som i navnet har ordet "løse". Hvis en slik overgang blir funnet, vil den bruke den, ellers logger den bare en melding. I fremtidige utgivelser vil dette kunne konfigureres.

Bare etter å ha konfigurert feltene ovenfor, hvis du vil, kan du overstyreSammendragogBeskrivelseverdier ved å klikke påAvansertknapp. Hvis du vil, kan du her konfigurere alle tilgjengelige felt for den spesifikke problemtypen. På grunn av Jenkins grensesnittutviklingsbegrensninger, må du søke etter ønsket felt fra de fire tilgjengelige felttypene etter å ha klikket på Add Field Configuration.

Viktig: Ikke la verdier for felt være tomme. Hvis du ikke fant ønsket felt i det gjeldende valgte alternativet, slett det før du prøver det neste.

Til slutt kan jeg ikke si at dette anbefales (selv om det er (smil)),les hjelpekoden for valider felteneog hvis advarselen det ikke er et problem for deg, klikk på knappen.

Bruk

Etter å ha bygget prosjektet, gå til testresultatsiden. Ved siden av testsakene vil du se enblå plussknapp, ved siden av enIngen sakbeskjed. Hvis du vilopprette et problem, ellerkoble til en eksisterende, klikk på den blå plussknappen og velg ønsket alternativ. Tilkobler fraet problem, klikk pårød x-knapp.

Når du oppretter, kobler og kobler fra problemer, anbefales det at du venter til siden lastes inn på nytt før du gjør noe annet for en ny test.Eventuelle feil vises inline.

Til slutt opprettes problemene dine, og du kan se dem ved å klikke på koblingene direkte fra Jenkins-grensesnittet.

Variabler

For tekstfelt i jobbkonfigurasjon og global konfigurasjon (kun sammendrag og beskrivelse) kan du bruke variabler som utvides til riktig verdi når problemet opprettes i JIRA. Du kan bruke alle miljøvariablene definert av Jenkins (selink). I tillegg kan denne plugin utvide et sett med forhåndsdefinerte variabler som viser informasjon om testen.

Implementeringsdetaljer