Jump to: navigation, search

Difference between revisions of "Lyo/ProjectPlans"

< Lyo
(Release Review Documentation)
(32 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
*OSLC query parser  
 
*OSLC query parser  
 
*HTTP client library  
 
*HTTP client library  
*Basic, Form, Oauth support  
+
*Basic, Form, OAuth support  
*Client query builder (contributors needed)
+
*TRS SDK
 +
*Client query builder ('''contributors needed''')
  
 
== Test suite for OSLC  ==
 
== Test suite for OSLC  ==
Line 25: Line 26:
 
*Improve Requirements and Change Management MUST coverage ('''contributors needed''')  
 
*Improve Requirements and Change Management MUST coverage ('''contributors needed''')  
 
*Improved query tests ('''contributors needed''')  
 
*Improved query tests ('''contributors needed''')  
*Improved Oauth tests
+
*Support for 2-legged OAuth ('''contributors needed''')
*Tests driven by resource shape documents ('''contributors needed''')
+
*<strike>Add coverage for TRS specification</strike> '''[DONE]'''
 +
*<strike>Tests driven by resource shape documents</strike> '''[DONE]'''
  
 
== Reference implementations for OSLC (RIOs)  ==
 
== Reference implementations for OSLC (RIOs)  ==
  
Reference implementations are currently available for the Change, Requirements and Architecture Management specifications. See the&nbsp;[[Lyo/LyoRIO|Lyo reference implementation]] page for details. Currently planned enhancements are:  
+
Reference implementations are currently available for the Change, Requirements, Architecture Management, Automation, and Tracked Resource Set specifications. See the&nbsp;[[Lyo/LyoRIO|Lyo reference implementation]] page for details. Currently planned enhancements are:  
  
*Support for the Quality Management domain ('''contributors needed''')
 
*Adoption of the OSLC Java SDK
 
 
*Refactoring to allow for pluggable RDF and application server technologies ('''contributors needed''')  
 
*Refactoring to allow for pluggable RDF and application server technologies ('''contributors needed''')  
*Improve reference implementation web UI ('''contributors needed''')
+
*<strike>Improve reference implementation web UI</strike> '''[DONE]'''
 
+
<br>
+
  
 
== Additional Proposed SDKs  ==
 
== Additional Proposed SDKs  ==
Line 43: Line 41:
 
Contributors are needed and welcome for all of the following:  
 
Contributors are needed and welcome for all of the following:  
  
*.NET (C# or other)
 
 
*Perl  
 
*Perl  
 
*Python  
 
*Python  
Line 49: Line 46:
 
*JavaScript
 
*JavaScript
  
= Milestones  =
+
= Upcoming Releases =
  
Currently planned milestones are:  
+
* Lyo 2.1 is planned for March 2014.
 +
* Lyo 3.0 is planned for June 2014.
 +
 
 +
We would like to move to quarterly releases starting with 2.1. Release content will come from the prioritized backlog, stakeholder feedback, and community contributions. Contributions are always welcome! Even small bug fixes help.
 +
 
 +
= Lyo Backlog =
 +
 
 +
Backlog items with rough prioritizations:
 +
 
 +
* [HIGH] Build a W3C LDP reference impl and SDK for LDP only
 +
** Simple JAX-RS + Jena based reference server
 +
** Reference apps to driver reference server (possibly Node)
 +
** Build a OSLC V3 ref impl and/or SDK on it
 +
* [HIGH] W3C LDP test suite
 +
* [HIGH] OSLC test suite and assessment report consumability
 +
** Deployable web app
 +
** Increase MUST/SHOULD coverage
 +
* [HIGH] - Re-factor test suites to use OSLC4J and drive them via resource shape and service provider resurces
 +
* [MEDIUM] Automation enablements
 +
** Hudson/Jenkins
 +
** Test tools
 +
** Chef/Puppet
 +
* [MEDIIUM] - JavaScript client library
 +
** Consumer navigation of provider (catalog->provider->resources)
 +
** Helpers for dialogs (frame handlers, etc)
 +
* [MEDIUM] Orion integration
 +
** [RDF formats] People like to hand crank some RDF formats, can we do something simple to plug into to provide some simple syntax highlighting and validation
 +
** [Node.js] Perhaps just a document of how to use Orion to do JS/Node dev with our impl.  FYI https://github.com/scripted-editor/scripted
 +
* [LOW] Perl enhancements, merge libs
 +
* [LOW] Python examples
 +
 
 +
== Lyo 2.1 (In progress) ==
 +
 
 +
Themes:
 +
 
 +
* Hudon/Jenkins OSLC Automation Provider
 +
* Test Suite Consumability
 +
 
 +
= Previous Releases  =
 +
 
 +
* Lyo 2.0 (October 2013)
 +
* Lyo 1.1 (February 2013)
 +
* Lyo 1.0 (October 2012)
 +
 
 +
== Lyo 2.0 ==
 +
 
 +
Themes:
 +
 
 +
* Support for Tracked Resource Set specification
 +
** TRS SDK
 +
** TRS Test Suite
 +
** TRS Reference Implementation
 +
** TRS Sample with Bugzilla
 +
 
 +
* LDP Reference Implementation
 +
** Server support for latest W3C draft
 +
** Pluggable triple store implementation with Jena TDB provided for reference
 +
** Sample data (net worth and bug tracking examples)
 +
 
 +
* Continuous Integration
 +
** Automated Hudson builds after any change
 +
** Snapshot artifacts published to repo.eclipse.org Maven repository after each build
 +
 
 +
== Lyo 1.1 ==
 +
 
 +
Themes:
 +
 
 +
* Enhancing OSLC4J
 +
** OSLC Query library
 +
** OSLC consumer library
 +
** Other minor enhancements (RDF collection support, etc) and bug fixes
 +
* Test suite enhancements
 +
** RM suite improvements
 +
** Automation suite
 +
* OAuth libraries
 +
* Additional samples
 +
** client library sample usage
 +
** automation reference implementation
 +
 
 +
== Lyo 1.0 ==
  
 
* M1 (Q4 2011) - theme is test suite enhancements
 
* M1 (Q4 2011) - theme is test suite enhancements
Line 85: Line 161:
 
     * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365622 Bug 365622 - QM and RM core spec coverage by the test suite ]
 
     * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365622 Bug 365622 - QM and RM core spec coverage by the test suite ]
 
  * Provide a community webcast on Lyo content
 
  * Provide a community webcast on Lyo content
 
  
 
* M3/Beta (Q2 2012) - theme is feature completeness
 
* M3/Beta (Q2 2012) - theme is feature completeness
Line 123: Line 198:
 
= Release Review Documentation =  
 
= Release Review Documentation =  
  
[http://wiki.eclipse.org/Image:Lyo-1.0-Release-Graduation-Review.pdf DRAFT copy of Lyo release/graduation documentation]
+
* [http://wiki.eclipse.org/images/3/34/Lyo-1.0-Release-Graduation-Review.pdf Lyo 1.0 release/graduation documentation]
 +
* [http://wiki.eclipse.org/images/1/1c/Lyo-1.1-Release-Review.pdf Lyo 1.1 release documentation]
 +
* [http://wiki.eclipse.org/images/1/1e/Lyo-2.0.0-Release-Review.pdf Lyo 2.0.0 release documentation]
 +
* [http://wiki.eclipse.org/images/4/4c/Lyo-2.1.0-Release-Review.pdf Lyo 2.1.0 release documentation]

Revision as of 17:33, 24 February 2014

Introduction

This page contains the project plans for the Eclipse Lyo project. The first part of the plan describes the various components of Lyo and the currently planned enhancements to functionality. This plan is subject to changes based on community participation and the importance of proposed functionality to the community - we encourage anyone interested to participate. The planning process will be as open as possible and this plan will be updated as it changes. Please provide feedback on the lyo-dev@eclipse.org mailing list.

Lyo Components

OSLC Java SDKs

  • Documentation
  • Constant strings for OSLC namespaces and providers
  • POJO model for OSLC resources
  • RDF parser and serializer
  • JSON parser and serializer
  • OSLC query parser
  • HTTP client library
  • Basic, Form, OAuth support
  • TRS SDK
  • Client query builder (contributors needed)

Test suite for OSLC

The test suite for OSLC is currently available on the Lyo project. See the Lyo test suite page for details. Currently planned enhancements are

  • Add reporting capabilities
  • Improve Change Management MUST and SHOULD requirement coverage (contributors needed)
  • Improve Requirements and Change Management MUST coverage (contributors needed)
  • Improved query tests (contributors needed)
  • Support for 2-legged OAuth (contributors needed)
  • Add coverage for TRS specification [DONE]
  • Tests driven by resource shape documents [DONE]

Reference implementations for OSLC (RIOs)

Reference implementations are currently available for the Change, Requirements, Architecture Management, Automation, and Tracked Resource Set specifications. See the Lyo reference implementation page for details. Currently planned enhancements are:

  • Refactoring to allow for pluggable RDF and application server technologies (contributors needed)
  • Improve reference implementation web UI [DONE]

Additional Proposed SDKs

Contributors are needed and welcome for all of the following:

  • Perl
  • Python
  • PHP
  • JavaScript

Upcoming Releases

  • Lyo 2.1 is planned for March 2014.
  • Lyo 3.0 is planned for June 2014.

We would like to move to quarterly releases starting with 2.1. Release content will come from the prioritized backlog, stakeholder feedback, and community contributions. Contributions are always welcome! Even small bug fixes help.

Lyo Backlog

Backlog items with rough prioritizations:

  • [HIGH] Build a W3C LDP reference impl and SDK for LDP only
    • Simple JAX-RS + Jena based reference server
    • Reference apps to driver reference server (possibly Node)
    • Build a OSLC V3 ref impl and/or SDK on it
  • [HIGH] W3C LDP test suite
  • [HIGH] OSLC test suite and assessment report consumability
    • Deployable web app
    • Increase MUST/SHOULD coverage
  • [HIGH] - Re-factor test suites to use OSLC4J and drive them via resource shape and service provider resurces
  • [MEDIUM] Automation enablements
    • Hudson/Jenkins
    • Test tools
    • Chef/Puppet
  • [MEDIIUM] - JavaScript client library
    • Consumer navigation of provider (catalog->provider->resources)
    • Helpers for dialogs (frame handlers, etc)
  • [MEDIUM] Orion integration
    • [RDF formats] People like to hand crank some RDF formats, can we do something simple to plug into to provide some simple syntax highlighting and validation
    • [Node.js] Perhaps just a document of how to use Orion to do JS/Node dev with our impl.  FYI https://github.com/scripted-editor/scripted
  • [LOW] Perl enhancements, merge libs
  • [LOW] Python examples

Lyo 2.1 (In progress)

Themes:

  • Hudon/Jenkins OSLC Automation Provider
  • Test Suite Consumability

Previous Releases

  • Lyo 2.0 (October 2013)
  • Lyo 1.1 (February 2013)
  • Lyo 1.0 (October 2012)

Lyo 2.0

Themes:

  • Support for Tracked Resource Set specification
    • TRS SDK
    • TRS Test Suite
    • TRS Reference Implementation
    • TRS Sample with Bugzilla
  • LDP Reference Implementation
    • Server support for latest W3C draft
    • Pluggable triple store implementation with Jena TDB provided for reference
    • Sample data (net worth and bug tracking examples)
  • Continuous Integration
    • Automated Hudson builds after any change
    • Snapshot artifacts published to repo.eclipse.org Maven repository after each build

Lyo 1.1

Themes:

  • Enhancing OSLC4J
    • OSLC Query library
    • OSLC consumer library
    • Other minor enhancements (RDF collection support, etc) and bug fixes
  • Test suite enhancements
    • RM suite improvements
    • Automation suite
  • OAuth libraries
  • Additional samples
    • client library sample usage
    • automation reference implementation

Lyo 1.0

  • M1 (Q4 2011) - theme is test suite enhancements
* Compliance Reporting
   * Bug 365198 - Would like to add the compliance toolkit to the TestSuite
   * Bug 365201 - Seeking a place to post OSLC compliance baseline reports
   * Bug 365206 - Post the OSLC Test Suite and Compliance toolkit instructions documentation
   * Bug 365302 - Post the "OSLC TestSuite and Compliance Test" demo/walkthrough video     
* Improved CM MUST and SHOULD requirement coverage
   * Bug 365618 - Complete CM MUST test cases
   * Goal: 100% CM MUST
   * Analyze CM SHOULD coverage
* Improved QM and RM MUST coverage
   * Bug 365622 - QM and RM core spec coverage by the test suite 
* Suite bug fixes and enhancements
   * Bug 363478 - Add test suite configuration for Bugzilla adapter 
   * Bug 357387 - Investigate uplift of TestSuites to Apache HttpClient 4.1.x 
   * Bug 365422 - Add RDF model validation to the OSLC JUnits. 
   * Already resolved improvements  
  • M2 (Q1 2012) - theme is initial Java SDK and refactored reference implementations
* Initial Java provider and client SDK
   * Initial contribution of OSLC4J
   * Initial documentation to help developer's get started with OSLC4J
* Example reference implementations based on the SDK
   * CM reference implementation based on OSLC4J
* Test suite improvements
  * Refactor test suite to enable additional domain tests more easily 
  * Test suite configurations for OSLC4J CM provider
* Improved QM and RM MUST coverage
   * Bug 365622 - QM and RM core spec coverage by the test suite 
* Provide a community webcast on Lyo content
  • M3/Beta (Q2 2012) - theme is feature completeness
* Full Java provider and client SDKs
* Re-vamped OSLC Workshop based on OSLC4J, including documentation
* Reference implementation can use pluggable RDF/application server providers
  * Stub service provider for use as an OSLC starter application
* Documentation
  * OSLC4J API reference guide
  * OSLC4J Tutorial and Getting started guide.
* Additional test suite enhancements to support apps written with the SDK
   * Bug 360175 - Validate ATOM responses 
   * Bug 360176 - Test for link labels 
   * Bug 360180 - Improve tests around partial get/put 
* Improve QM domain spec MUST coverage
   * Goal (dependent on community): 75%
* Test suite enhancements and bug fixes
  * Bug 360184 - Use OSLC throughout the test suite
  * Bug 360183 - Define test suite cases in the form of scenarios 
  • Release candidates and 1.0 (Q3 2012) - theme is release readiness
  * Some reference implementation refactored to take advantage of SDK
     * QM reference implementation based on OSLC4J
     * AM reference implementation based on OSLC4J 
  * Test suite enhancements
     * Improve CM, QM, RM core and domain SHOULD and MAY coverage
     * Improve RM domain spec MUST coverage
  * Stretch items based on community participation
     * non-Java language SDKs (could be in earlier milestones based on participation)
        * C#/.NET
        * Scripting languages (Python, Perl, Ruby)
        * JavaScript client library
     * Additional reference implementation and test suite enhancements
  * Release shutdown work

Release Review Documentation