1) CB plugin for Jenkins 2) Requirements Mapping

Transcription

1 1) CB plugin for Jenkins 2) Requirements Mapping (Some of the names used for variables in trigger/build as provided by the plugin have already been updated to ensure more overall consistency. I left the screenshots in, no reason to change them.)

2 1) CB plugin for Jenkins Two main CB Jenkins plugin parts: 1. Status-check on CB issues and other artifacts to trigger a Jenkins build (CB Trigger) 2. Publish build results (stdout, stderr, status, build product, etc.) back to CB (CB Publisher)

3 Installation

4 Features Superior to previously provided CB build features, it is more Scalable.. distributed build topology Flexible.. more finer grained build trigger, publish to multiple server, adjust to custom tracker layout. Secure.. Jenkins build server runs as separate process (and on separate boxes) Extensible.. (using other Jenkins plugins)

5 Build Topologies JE CB JE CB CB JE JE CB Trigger CB Publisher

6 Architecture Jenkins Build Trigger Post- build Publisher Logging Groovy Encapsulation, DSL, Closures, Pretended Properties CB Remote API CB

7 Jenkins Workflow Scheduler n CRON pattern matches? y CB Trigger script CB Trigger returns true n y Build CB Publisher od

8 1) CB Trigger Scheduler always calls Trigger script, trigger script may or may not trigger build. Trigger should query a CB instance to decide what to do, e.g. check tracker status

9 Job configuration (Trigger) Configure Scheduler (CRON like) to call a trigger script at the configured period. Script must end with boolean expression! (CodeMirror supported syntax coloring)

10 Trigger JE UI logger Boolean expression! Called by scheduler If the script evaluates to true, a build is issued. The last statement expression must be a boolean expression of some sort!!!

11 CB Trigger Log for each job Trigger Log

12 Trigger Log View Live view Scheduler triggered script execution evaluation Trigger Script Expression evaluation triggers build ( or not)

13 2) CB Publisher Always called after build if checked Has implicit Build/Job/Jenkins Environment variable If publisher script fails, the build might fail too

14 CB - Publisher Called after build Implicit variables: $build_????? If the script above fails, what should be done?

15 Publisher Called after build Should add/manage some resources to CB: Forum post, new tracker item (e.g buildlog), new item attachment, upload file(s) Options to mark the build unstable, let it fail, or ignore if something goes wrong here.

16 Trigger/Publisher Help: Provided variables by Jenkins

17 Jenkins plugin context handling (Trigger/Publisher) default import Must not be local (no def )! import cb.script.* safe logout cb.logout() Default import for package cb.script.*, no need to specify an import statement in a trigger/publisher. (You can still import it, though) After executing a trigger and publisher, the jenkins plugin is closing open sessions, no need to call cb.logout() at the end of your trigger/publisher (You can still call it though) No package definition!

18 CB BuildLog Tracker $build_result $build_output $build_duration

19 Thoughts If CB Publisher stays unchecked, the Trigger alone can be used to perform some regular maintenance. It does not have to return true to trigger a build. The CB scripting library can be extended to create a Build tracker (maybe use the Jenkins job name for that) if such a tracker is not present in a project. There is no logout being called from the Jenkins scripts. This is optional for a script. The Jenkins plugin will perform a logout on all open session for a job after the script finishes. There are still some class loading issues between Hessian s Dynamic Proxy / Groovy and the Jenkins URLClassloader. Some more tests are needed here. It only CB affects classes handling custom fields. Plenty of simple, but flexible trigger examples can be provided. I will look into Janky and other CI servers that just emerged

20

21 2) Scripting Examples Why Groovy? Expressive language and concise code. Has features supporting ad-hoc solutions: dynamic execution, duck typing, closures, DSLs, pattern support, native support for Maps/Lists, Groovy should be used on top of CB Remote API (both in one JVM), since CB s Remote API is not really designed to be used by the enduser (e.g. artifact management). hence the scripting layer on top of the RemoteAPI.

22 Example1 - Trigger: A simple trigger, scheduled every hour - Publisher: Forum posting Build

23 Example 2 - Trigger: A special forum posting Build - Publisher: New Tracker log with attachment

24 Example 3 - Trigger: Not closed items - Publisher: upload to documents Build

25 Example 4 - Trigger: document status - Publisher: New Tracker log Build

26 Example 5 (UI Build badges and summary) Create Badges and Summary in Jenkins UI for build Build details

27 Example 6: XRef CB-BuildLog and JE-Build CB Publisher script xrefs CB abd Jenkins: click cbinfo() creates JE UI elements 1) Xref Links in Publisher click Submit creates the BuildLog propkey == CB label name propvalue == CB field value 2) XRef of links in UI This should be a hot link! - URL Data type for a custom field!

28 Cool Groovy features for CB DSL Time management Readable timespans/durations for postings/tracker items Pretended Properties e.g. Checking/Changing status, or assigning values to fields Closures Find a task item Operator overloading upload/download files

29 DEV aspects 2 Projects, ~1000 LOC Java Jenkins (maven build required by Jenkins) ~2000 LOC Java - Scripting API layer ~2000 LOC JS, Jelly, HTML, CSS, - UI 2 Products, cbext jar Stand-alone scripting / API / REQ Annotation Bundles (cb-api.jar) cb snapshot.hpi Full Jenkins plugin (bundles cb-scripting-5.8.jar) Tested with ~20 concurrent Jenkins Jobs that query the same tracker and post the result to the same BuidLog.

30 Final Thoughts CB improvements that would help within this context: A New Tracker Type BuildLog With pre configured fields for a typical build. Probably easy to provide URL types for fields Would be nice to have field values being URLs (and Interwiki links). They would map to clickable links when presented. Maybe a more streaming like approach to fetch issues using the API. What remains to be done? Scripting API Documentation, Links to examples, Plugin hosting on Jenkins.org? More complex examples (check commits, etc.) more testing Plugin improvements Page for adhoc script execution (trigger/publisher testing) Logging,

31

32 2) ReqMapper Mapping Test/Test Results to functional Requirements in CB Post Test Automation Integrated into CB Jenkins plugin

33 Source Unit tests Source matches functional requirements? Testing Framework Test reports (CB hosted) Requirements Jenkins Testing ReqMapper

34 Example? CSTable t = DataIO.table(file, Climate"); System.out.println(t.getName());

35 Annotate Test with Req ID public void testtablename() { //... CSTable t = DataIO.table(r, Climate"); Assert.assertEquals( Climate, t.getname()); } 2) Run tests, test reports get created... <testcase classname="oms3.io.tabletest" name="testtableinfo" time="0.119"> <failure message="expected:<2> but was:<1>" type="junit.framework.assertionfailederror"> junit.framework.assertionfailederror: expected:<2> but was:<1> at oms3.io.tabletest.testtableinfo(tabletest.java:54) </failure> </testcase> <testcase classname="oms3.io.tabletest" name="testtablelayout" time="0.0020" /> <testcase classname="oms3.io.tabletest" name="testtablename" time="0.0010" /> <testcase classname="oms3.io.tabletest" name="testfirsttable" time="0.0030" />... 3) testreport 1) Test/Testreport driven change in REQ Status and content. 4) Req Mapper

36 REQMapper: Jenkins integration See next slide

37 REQ Mapper script For each test: 1. Fetch the CB REQ based on its Test Req annotation 2. Transfer: req.<cbfields> test.<testfields>

38 Thoughts Example here shows Java/Junit. Other Unit testing frameworks can be implemented too. We ve developed a language neutral annotation/parsing library. ReqMapper is bundled with the Jenkins plugin, now it should be easy to integrate REQ feedback into CI workflows. The Jenkins plugin development happens in Maven, hence the CB plugin is created as Maven project. All of the scripts can be executed external to Jenkins too. Extending the plugin to execute a script before saving might be useful (maybe next step) Codemirror javascript is used for syntax coloring and is bundled with the CB plugin.

39 That s it git://javaforge.com/cbci

40 codebeamer Plugin for Jenkins Scalable... distributed build topology Flexible more finer grained build trigger, publish to multiple server, adjust to custom tracker layout. Secure Jenkins build server as separate process Jenkins behind firewall Efficient Groovy scripting, concise language Extensible... use it with other Jenkins plugins

41

42 codebeamer plugin for Jenkins Two main functions: 1. Scheduled Status-check on CB issues and other artifacts to trigger a Jenkins build (Trigger) 2. Publish build results (output, status, build product, etc.) back to CB (Publisher)

43 1) Query (Trigger) 2) Build 3) Publisher codebeamer Jenkins (with cb.hpi)

44 Jenkins Scheduler n CRON pattern matches? y CB Trigger script codebeamer Trigger returns true n y Build CB Publisher

45 DEMO