Bonfire... How'd You Do That?! - AtlasCamp 2011

How do you write a JIRA plugin that works across 4.2, 4.3 and 4.4? How can you find the metadata for the JIRA issue creation form? How can you create the issue itself, and attach the screenshot? And how is this going to change in JIRA 5.0 and beyond? This talk will cover all this, and more!

1. Saturday, 1 October 2011

2. Howʼd you do that?
Ian Grunert
Developer, Atlassian
Bonfire
2
Saturday, 1 October 2011

3. Agenda
3
Saturday, 1 October 2011

4. •What is Bonfire?
Agenda
3
Saturday, 1 October 2011

5. •What is Bonfire?
•Building plugins for
multiple JIRA
versions
Agenda
3
Saturday, 1 October 2011

6. •What is Bonfire?
•Building plugins for
multiple JIRA
versions
•JIRA integration in
Bonfire - problems
and solutions
Agenda
3
Saturday, 1 October 2011

7. What is Bonfire?
4
Saturday, 1 October 2011

8. •Exploratory
testing tool
What is Bonfire?
4
Saturday, 1 October 2011

9. •Exploratory
testing tool
•JIRA plugin
targeting multiple
JIRA versions
What is Bonfire?
4
Saturday, 1 October 2011

10. •Exploratory
testing tool
•JIRA plugin
targeting multiple
JIRA versions
•Browser
extension for
major browsers
What is Bonfire?
4
Saturday, 1 October 2011

11. •Browser extension -
JIRA client
•Submit bug reports
directly from your
browser
Bonfire -> JIRA Integration
5
Saturday, 1 October 2011

12. •JIRA Plugin - track and
manage testing activities
•Test Sessions
•Session Notes
•http://
www.atlassian.com/
bonfire
Bonfire -> JIRA Integration
6
Saturday, 1 October 2011

13. Building multiple JIRA version
supported plugins"
7
Saturday, 1 October 2011

14. •Why?
Building multiple JIRA version
supported plugins"
7
Saturday, 1 October 2011

15. •Why?
•Problem points?
Building multiple JIRA version
supported plugins"
7
Saturday, 1 October 2011

16. •Why?
•Problem points?
•Some Solutions.
Building multiple JIRA version
supported plugins"
7
Saturday, 1 October 2011

17. •Increase the size
of your market
•Should try and
support two
versions back.
Maximise your customer base
8
Earlier 4.0 4.1 4.2 4.3
Saturday, 1 October 2011

18. •Deploy to multiple internal
instances
•For example,
https://support.atlassian.com/
is 4.3, where as
https://jira.atlassian.com/ is
4.4.
Multiple JIRA instances
9
Saturday, 1 October 2011

19. •Test against EAPs!
•Give feedback.
•Participate in API building
•Support JIRA 5.0 from
launch
Be ready for upgrades
10
Saturday, 1 October 2011

20. Problems
11
Saturday, 1 October 2011

21. •Java API changes
Problems
11
Saturday, 1 October 2011

22. •Java API changes
•JS and Markup changes
Problems
11
Saturday, 1 October 2011

23. •Java API changes
•JS and Markup changes
•Testing across multiple
versions
Problems
11
Saturday, 1 October 2011

24. Branching
12
Saturday, 1 October 2011

25. •Cleaner code
Branching
12
Saturday, 1 October 2011

26. •Cleaner code
•Is this good or bad?
Branching
12
Saturday, 1 October 2011

27. •Cleaner code
•Is this good or bad?
•Overhead
Branching
12
Saturday, 1 October 2011

28. •Cleaner code
•Is this good or bad?
•Overhead
•Builds
Branching
12
Saturday, 1 October 2011

29. •Cleaner code
•Is this good or bad?
•Overhead
•Builds
•MergingBranching
12
Saturday, 1 October 2011

30. •Cleaner code
•Is this good or bad?
•Overhead
•Builds
•Merging
•Testing
Branching
12
Saturday, 1 October 2011

31. One build, multiple versions
13
Saturday, 1 October 2011

32. One build, multiple versions
13
•Messier code
Saturday, 1 October 2011

33. One build, multiple versions
13
•Messier code
•No merging
Saturday, 1 October 2011

34. One build, multiple versions
13
•Messier code
•No merging
•Shipping one jar
Saturday, 1 October 2011

35. One build, multiple versions
13
•Messier code
•No merging
•Shipping one jar
•All tests in one branch
Saturday, 1 October 2011

36. One build, multiple versions
13
•Messier code
•No merging
•Shipping one jar
•All tests in one branch
•Know when touching
problem areas
Saturday, 1 October 2011

37. Six multi-version plugin
techniques
14
Saturday, 1 October 2011

38. 1. CI using AMPS
Six multi-version plugin
techniques
14
Saturday, 1 October 2011

39. 1. CI using AMPS
2. Javascript / Markup changes - AJS.version
Six multi-version plugin
techniques
14
Saturday, 1 October 2011

40. 1. CI using AMPS
2. Javascript / Markup changes - AJS.version
3. Non-compile breaking API changes - BuildUtilsInfo
Six multi-version plugin
techniques
14
Saturday, 1 October 2011

41. 1. CI using AMPS
2. Javascript / Markup changes - AJS.version
3. Non-compile breaking API changes - BuildUtilsInfo
4. UI location changes - Web fragment conditions
Six multi-version plugin
techniques
14
Saturday, 1 October 2011

42. 1. CI using AMPS
2. Javascript / Markup changes - AJS.version
3. Non-compile breaking API changes - BuildUtilsInfo
4. UI location changes - Web fragment conditions
5. Compile breaking changes - Reflection
Six multi-version plugin
techniques
14
Saturday, 1 October 2011

43. 1. CI using AMPS
2. Javascript / Markup changes - AJS.version
3. Non-compile breaking API changes - BuildUtilsInfo
4. UI location changes - Web fragment conditions
5. Compile breaking changes - Reflection
6. Compile breaking changes - Dynamic module types
Six multi-version plugin
techniques
14
Saturday, 1 October 2011

44. •Run CI against all supported versions
•Use testGroups in AMPS to facilitate this
•Quickly identify compile-time issues introduced
Continuous Integration
15
Saturday, 1 October 2011

45. 16
Saturday, 1 October 2011

46. 17
Saturday, 1 October 2011

47. •AJS.version to find AUIʼs version, split the code path
•https://developer.atlassian.com/display/AUI/AUI
+Version+Matrix
JavaScript / Markup changes
18
Saturday, 1 October 2011

48. 19
Saturday, 1 October 2011

49. 20
Saturday, 1 October 2011

50. •BuildUtilsInfo in JIRA can be used to find the JIRA
version and split the code path
Querying JIRA version
21
Saturday, 1 October 2011

51. •Allows you to define a boolean condition as to whether
or not a web-fragment shows up
•IsPriorToJIRAVersion condition to only show web
fragments in certain JIRA versions (uses
BuildUtilsInfo)
Web-fragment Conditions
22
Saturday, 1 October 2011

52. Example
23
Saturday, 1 October 2011

53. •Use this:
•To load a class only present in later versions of JIRA
•To load a class that changes names across JIRA
versions
Compile breaking changes -
Reflection"
24
Saturday, 1 October 2011

54. Example
25
Saturday, 1 October 2011

55. Example
26
Saturday, 1 October 2011

56. •JIRA 5.0 removes OSUser
entirely
•Replaced with Crowd user
•Large scale compile time
breaking changes
How does this look in JIRA 5?
27
Saturday, 1 October 2011

57. •Approach taken by Bonfire was to drop 4.2 support,
and remove as much OSUser as possible
•Some instances of OSUser couldnʼt be removed
(IssueTabPanel for example)
•Then create a branch, and change the imports for the
branchWe tried branching
28
Saturday, 1 October 2011

58. •In JIRA 4.3 / 4.4, use special methods to get crowd
user object
•jiraAuthContext.getUser for OSUser
•jiraAuthContext.getLoggedInUser() for Crowd User
•OSUser based methods are deprecated in 4.3 / 4.4
Deprecation pains
29
Saturday, 1 October 2011

59. •In JIRA 5.0, the better 4.3/4.4
Crowd user methods are now
deprecated (moved to nicer
named methods)
•Doing the right thing yields
lots of warnings
Deprecation pains
30
Saturday, 1 October 2011

60. •For the same reasons outlined before
•No eyes on JIRA 5.0 changes
•Merge pain
•Multiple jars
•How can we fix this?Branching sucks!
31
Saturday, 1 October 2011

61. •Don Brown created jira4-compat to allow Speakeasy
to support 4.2 -> 5.0 without branching
•Uses dynamic plugin module types to allow for new,
cross version compatible module types
•4 maven modules, compile different maven modules
based on JIRA version
•FactoryBean Spring Component to inject the correct
dependency
Dynamic module types
32
Saturday, 1 October 2011

62. 1. Multi-version support - you should be doing it!
2. Donʼt have to branch to do multi-version.
3. The documentation can help!
http://confluence.atlassian.com/display/JIRA/Plugin
+Developer+Notes+for+JIRA+5.0Bonfire multi-version
experiences - takeaways
33
Saturday, 1 October 2011

63. Bonfire remote JIRA integration
34
Saturday, 1 October 2011

64. Bonfire remote JIRA integration
35
Saturday, 1 October 2011

65. Bonfire remote JIRA integration
35
1. Authentication
Saturday, 1 October 2011

66. Bonfire remote JIRA integration
35
1. Authentication
2. Issue metadata
Saturday, 1 October 2011

67. Bonfire remote JIRA integration
35
1. Authentication
2. Issue metadata
3. Issue Creation
Saturday, 1 October 2011

68. Authentication
36
•Canʼt store the password
•Ideally, single step
authentication
Saturday, 1 October 2011

69. Authentication
37
•Use JIRA REST
•Returns a cookie
•Use cookie for all future
requests
•Re-authenticate on
cookie timeout
Saturday, 1 October 2011

70. •Need metadata to draw the
issue creation form
•XML-RPC
•Missing fields
•Could not create on some
instances
Issue metadata
38
Saturday, 1 October 2011

71. •Now on custom REST
•Bad: extra code
•Good: In control, works on
all instances, can add new
Bonfire specific features
Issue metadata
39
Saturday, 1 October 2011

72. •XML-RPC
•Gaps filled with REST
(e.g. labels)
•SOAP for attachments
Issue creation
40
Saturday, 1 October 2011

73. •Now on custom REST
•Bad: extra code
•Good: In control, works on
all instances, can add new
Bonfire specific features
•Déjà vu?
Issue creation
41
Saturday, 1 October 2011

74. •In JIRA 5.0, neither custom
REST resource would be
required
Good news, everyone!
42
Saturday, 1 October 2011

75. 1. Test on real / complex data!
(use atlas-create-home-zip)
2. Favour REST
3. Donʼt fear custom REST resources
Bonfire Remote API
experiences - takeaways
43
Saturday, 1 October 2011

76. Thank you!
Saturday, 1 October 2011