OSLC Overview. Michael Fiedler, IBM , ARTEMIS Technology Conference ARTEMIS Joint Undertaking

Transcription

1 OSLC Overview Michael Fiedler, IBM , ARTEMIS Technology

2 Agenda Motivation and background Community Architecture Specification Contents Eclipse Lyo

3 The Core Problem of Tools Producing a good tool is relatively easy Producing a single tool to support complex processes like product or software lifecycles is impossible Processes vary a lot from customer to customer Most customers will not or cannot deploy a single solution But, integrating multiple tools has been unsatisfactory

4 Need for Open Collaboration on Solutions Past Integration Approaches Have Fallen Short Limited Participation Limited to small set of business partners No open process for others to join in Limits solution to particular use cases and technologies Point-to-point integrations Built after the fact with limited product APIs Solution focuses on 2 tools in hand Lack of transparency No consensus driven approach No external review No visibility into solution Restrictive licenses and intellectual property License fees Fear of giving up IP Forces alternative solutions Restrictive Participation

5 Need for a Better Solution Past Integration Approaches Have Fallen Short Limited choice and coverage Single repository Can I really expect one vendor to provide all the functionality I need? And what about my existing tools? Point-to-point integrations How can I ever upgrade one tool without breaking everything else? Universal metadata standard How did I ever think all those vendors would be able to agree? Standard implementations Did I really believe that every vendor would rewrite their tools on a single framework? Slow to emerge and disruptive to adopt

6 Open Services for Lifecycle Collaboration (OSLC) An initiative aimed at simplifying data linking and tool integration across the lifecycle Barriers to sharing resources and assets among tools Multiple vendors, open source projects, and in-house tools Private vocabularies, formats and stores Entanglement of tools with their data Open Services for Lifecycle Collaboration Community Driven specified at openservices.net Specifications for ALM, PLM and DevOps Interoperability Inspired by Internet architecture Loosely coupled integration with just enough standardization Common resource formats and services A different approach to industry-wide proliferation

8 OSLC and Open Community Iterative Specification Authoring Open Services for Lifecycle Collaboration open community. open interfaces. open possibilities Identify Scenarios Iterate on working drafts Minimalist/additive approach Not a complete definition for a given area Scenario driven scope Co-evolve spec and implementations Open participation around active core group Call it a spec Gain technical consensus, collect nonassert statements

9 OSLC History A Brief Look Back Rational Team Concert, ClearQuest, Change Ship 1 st OSLC Support RQM, RRC, RAM OSLC Support RTC, ClearQuest, Change Ship CM 2.0 Support Launched 2008 CM WG Launched CM 1.0 Final QM, RM, Asset 1.0 Final CM 2.0 Final QM, RM, Core 2.0 Final

10 OSLC Community Eleven workgroups operating at openservices.net Domain focused workgroups (e.g. CM, QM, RM) Common issues and patterns (Core) Solution oriented workgroups (e.g. PLM) Range of interests, expertise, involvement 400+ registered community members Individuals from 34+ different companies have participated in OSLC Worthy of note PLM Workgroup Open source Siemens leadership Eclipse Customer and integrator involvement GM, Northrop Grumman, Tieto, Integrate Systems, Siemens and EADS Growing interests beyond ALM and PLM Vocabulary / Business Glossary Integration Service Management/Cloud DevOps and Automation Scope Draft Converge Finalize Core 2.0 Change Management 2.0 Requirements Management 2.0 Quality Management 2.0 Architecture Management 2.0 Asset Management 2.0 Estimation and Measurement 1.0 Software Configuration Management 1.0 Reporting PLM Automation Communication Website Non-Spec 10

11

13 Linked Lifecycle Data Data Integration for the 21 st Century Inspired by Internet principles, implemented with Internet technologies: simple interfaces for exchange of resources If the entire Web can connect like this, would the same idea work for ALM? Loosely coupled: everything is a resource linked together with URLs Technology neutral: treats all implementations equally Minimalist: defines no more than necessary for exchange of resources Incremental: deliver value now, add more value over time Openly published standards: free to implement and irrevocable 13 13

14 and then we need a way to go beyond simply linking data Dashboards & reports Traceability & impact analysis Universal configuration mgt End-to-end process Security Some services don t belong in any one tool Improving pair-wise tool integration is necessary, but not sufficient

15 Not Just PLM and ALM but in DevOps and IT as well Lifecycle Tool Change Management Service Management Help Desk Lifecycle Tool Requirements Management Lifecycle Tool Quality Management Service Management Deployment

17 Anatomy of a Specification OSLC Core spec defines HOW to use HTTP and RDF, how to define resources and services Defines some common resource types and properties OSLC domain specs (Change Management, Requirements, etc.) Define WHAT resources and services required in the domain Resource types, properties and relationships Service providers, creation factories, query capabilities, operations Solutions oriented workgroups (e.g. PLM) Define extensions to core or domain specifications Define resources applicable to the solution Provide guidance on application of OSLC concepts

18 Specification Technical Components Discovery HTTP C.R.U.D. for Resources Delegated UI for Create and Select Query UI Previews for Resource Links Standard Resource Representations

19 Discovery of Capabilities

20 Resource CRUD Resource Retrieval HTTP GET and standard HTTP content negotiation Client uses HTTP Accept request header to specify desired resource formats (RDF/XML, Abbreviated XML, JSON) Query syntax for filtering and partial resource representation Resource Creation Create a resource using HTTP POST and content being resource format of choice Service provider resource defines URI for the POST Resource formats defined by the specifications. Optionally, resource shapes can be provided to assist with creation Resource Modification HTTP GET to retrieve the resource to be modified. HTTP PUT to update it. Etags and If-Match used to detect conflicting updates Unknown content in the resource must be preserved by clients

21 Resource representations OSLC services should handle any type of resource Not just those defined by OSLC domain specs Resources defined by OSLC use a RDF data model therefore are simply defined by their set of properties OSLC services MUST produce and consume RDF/XML representations Clients and services MUST NOT assume any subset of RDF/XML Other representations are allowed such as: XML: OSLC defined format that allows for consistent formats and is RDF/XML valid JSON: Rules for representing namespaces and QName properties Turtle: No constraints, use as-is Atom Syndication Format: <atom:content> SHOULD be RDF/XML

22 Querying for resources Query Capability has base URI Clients form query URI and HTTP GET the results OSLC services MAY support OSLC Query Syntax

23 Delegated UI's key points Supports both creation and selection of resources Two communication protocols are supported for iframes: HTML5 postmessage() preferred method Supported in most modern browers Window object's window.name Supported in older browsers and Eclipse embedded web widget Consumer selects which protocol to use, informs provider via fragment identifier Tremendous value for resource creation Traditionally most service logic was communicated to client and new dialog built Now the rules for creation and dialog change as needed Prefilling of creation dialog done by creating a dialog resource HTTP POST of resource format to creation dialog URL, response is URL of dialog prefilled

24 And more... Common property and resource definitions covering Resource shapes Resource typical properties: title, description, identification, Leveraging Dublin Core and FOAF Discussion/comments OSLC services MAY offer OAuth 1.0a Three legged OAuth for webapp to webapp authentication Two legged OAuth for client to webapp authentication OSLC services MAY offer HTTP BASIC Auth User name and password sent in the clear with Base64 encoding Should be done via HTTPS only

26

27 Eclipse Lyo Evolution of OSLC tool repositories on SourceForge and some private to community participants Project approved by Eclipse PMC in July 2011 with the goal of providing an SDK to enable adoption of OSLC specifications, including Code libraries Reference implementations of specifications Test suites and test reporting Samples, tutorials and documentation NOT a plugin for the Eclipse IDE Eclipse chosen as the home for the project for its mature governance model and IP policies. Eclipse community includes tool vendors and tool interop projects. Other participants in the OSLC community are also active in Eclipse projects related to OSLC. Tasktop (Mylyn) Oracle (Hudson) Institut Telecom Project content is dual-licensed under the Eclipse Public License and the Eclipse Distribution License

28 Current Lyo Content Initial code contributions live in September 2011 Reference Implementations for OSLC (RIOs) for the Change, Requirement and Architecture Management specifications. Provides samples of implementations Enable prototyping and experimentation during spec development Possible starting point for integration adapters or new service providers Co-developed with the OSLC test suite to improve both OSLC Test Suite and Reports Measure implementation compliance against Core and domain specifications Improve implementation quality by finding bugs Currently covers core and CM. Other domains will follow Initial focus is on MUST items, followed by SHOULD and MAY Reports provide both summary and detailed results Samples Change Management adapter for Bugzilla

29 OSLC Test Suite As an OSLC Compliance Assessor Coverage Metrics Distinct Compliance Levels

30 OSLC Test Suite As an OSLC Adoption Accelerator Provide Documentation Provide Troubleshooting Tips Provide Test Strategy Guidance Help Setup/Configure Help to learn OSLC specs - In-line Code Comments - OSLC spec and test mapping

31 Plans for new content in 2012 Code libraries OSLC4J Java library for OSLC provider and consumer implementations Based on OSLC related Java annotations and JAX-RS for REST services Includes a Change Management reference implementation and other samples Modular structure avoids forcing dependence on specific technologies. Jena and Apache Wink provide RDF, JSON and JAX-RS capabilities out the box Implementers can choose to use OSLC4J with other providers such as OpenRDF and Jersey Other technologies (.NET, PHP, JavaScript, Python, Perl) Looking for contributors Test Suites Increase domain coverage Increase specification coverage within domains Move the tests towards a true compliance suite Samples Excel Change Management adapter contributed by Japan Technical Sales team Oauth consumer and provider samples Sample integrations with Rational Jazz products

32 Participating in Lyo and OSLC Participating in Lyo Lyo is currently source only goal to have builds of consumable jars starting in February Looking for developers interested in promoting OSLC adoption by developing SDKs, reference implementations, compliance tests and examples Visit to get more info, see milestone plans, etc Subscribe to the mailing list and introduce yourself.

33 Participating in Lyo and OSLC Participating in OSLC OSLC workgroups develop integration scenarios and specifications to address different aspects of the product and software lifecycles Participate in new or evolving workgroups Visit and join in the discussions on the forums, mailing lists and workgroup meetings.

34

35 Sample integration using OSLC Integration of open source change tracking tool (Bugzilla) with a commercial quality management tool Uses an adapter or proxy approach instead of modifying the change tracking tools source Adapter converts OSLC requests/responses to the change tracking tools native API. The adapter and commercial tool are configured to link their change management and quality management data using OSLC 35

36 Create a new defect using a delegated creation UI 36

37 OSLC compact view of the defect 37

38 Clicking link takes user to the linked change request 38

39 Resources OSLC Web Site OSLC Primer OSLC Tutorial Open source - Eclipse Lyo Project

40 Questions? Michael Fiedler,

41 Backup Backup

42 Resource linking Links are just properties: whose property values are just URIs Turtle format for a bug resource (abbrev) < a oslc_cm:changerequest ; dcterms:relation < Don't make assumptions about the target of links OSLC supports an open model Needed to achieve goal of loosely coupled integrations Clients need to be flexible and expect anything Sometimes we need to provide additional data about links: label, owners, etc. Special cases where links need more representation

43 Query syntax example Find high severity bugs created after April fools day cm:severity="high" and dcterms:created>" " Find bugs related to test case oslc.where=qm:testcase=< Find all bugs created by John Smith dcterms:creator{foaf:givenname="john" and foaf:familyname="smith"}

44 Query Syntax Overview Filter results by appending oslc.where= with query clause to query base URI Only boolean operation allowed is and which represents conjunction "or" for disjunction is not defined in the interests of keeping the syntax simple. Retrieve just what you want with oslc.select= Defined ordering using oslc.orderby= 'in' operator: Test for equality to any of the values in a list. The list is a comma-separated sequence of values, enclosed in square brackets: in [ high, critical ] Comparison Operators = test for equality!= test for inequality < test less-than > test greater-than <= test less-than or equal >= test greater-than or equal Full-text search via oslc.searchterms=

45 Delegated UI Explained #2 iframe's src set to delegated UI's URL #1 Click to launch delegated UI #3 Selection made #4 OK pressed sends message (link+label) to parent window

46 UI Preview Scenario supported: hover over link to get in context preview of resource Simple resource format defined and retrieved using HTTP content negotiation

47 OSLC4J samples Decorate Plain Old Java Objects with OSLC annotations Resource class = "Change Request Resource Shape", describes = Constants.TYPE_CHANGE_REQUEST) public final class ChangeRequest extends AbstractResource { private final Set<URI> affectedbydefects = new TreeSet<URI>(); private String description; Resource property text (reference: Dublin Core) about resource represented as rich text in XHTML public String getdescription() { return description; } REST OslcMediaType.APPLICATION_XML, OslcMediaType.APPLICATION_JSON}) public ChangeRequest[] getchangerequests(@queryparam("oslc.where") final String where)