![Agenda
• Versioning in OSGi
• How tools can help
• Tooling available
• Technical background
• Status
“Humans are already incapable of handling version
management on the scale required today. Tools need
rules and guidelines … [and] it is paramount that
versions have semantics.”
Semantic Versioning,
Technical Whitepaper, rev 1.0](https://image.slidesharecdn.com/osgicommunityevent2010-automatedsemanticversioningforosgibundles-101108074812-phpapp02/85/OSGi-Community-Event-2010-Automated-Semantic-Versioning-for-OSGi-Bundles-2-320.jpg)
OSGi Community Event 2010 - Automated Semantic Versioning for OSGi Bundles
- 1. Premek Brada | University of West Bohemia, CZ Automated Semantic Versioning for OSGi Bundles Wednesday, 29th September 2010 Supported by the Grant Agency of the Czech Republic, project 201/08/0266
- 2. Agenda • Versioning in OSGi • How tools can help • Tooling available • Technical background • Status “Humans are already incapable of handling version management on the scale required today. Tools need rules and guidelines … [and] it is paramount that versions have semantics.” Semantic Versioning, Technical Whitepaper, rev 1.0
- 3. Versioning in OSGi • Enables version co-existence at runtime • Used by the resolver – exported package: version – imported package: range – matched as part of constraint solving Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: Apache Felix Configuration Admin Service Bundle-SymbolicName: org.apache.felix.configadmin Bundle-Version: 1.0.10 Export-Package: org.apache.felix.cm;version="1.0",org.apache.felix.cm. file;uses:="org.apache.felix.cm,org.osgi.framework";version="1.0“ (…) Import-Package: org.apache.felix.cm;version="1.0",org.apache.felix.cm. file;version="1.0",org.osgi.framework;version="1.3“ (…) References •R4 Core spec, mainly 3.6.2 Version Matching •Semantic versioning whitepaper
- 4. Versions yes, but semantic…? • Bundle-Version: 0.9.0 x Bundle-Version: 1.0.0 “Marketing” vs “Semantic” version IDs Original Semantic Changes … … … 1.0.4 1.0.2 (none) 1.2.0 2.0.0 modification … … … 1.2.2 2.0.2 (none) 1.4.0 2.1.0 extension Original Semantic Changes 0.9.0 1.0.0 n/a 0.9.2 1.1.0 extension 1.0.0 2.0.0 removal Example – revision streams of two bundles
- 5. Versions yes, but semantic…? • Export-Package: x.y.z;version=0.9.0 x Export-Package: x.y.z;version=1.0.0 Resolver believes package version IDs
- 6. OSGi Semantic versions • 1.0.0 -> 1.1.0 -> 2.0.0 signal changes – Semantics = versioning policy • OSGi world has one – R4 Core suggests M.m.µ.q as common – Semantic versioning whitepaper requires this • Note: different contexts => different consequences – API x implementation package – consumer x provider x implementer (API)
- 7. How tools can support OSGi semantic versions IDE: bundle development, manifest editing o inferring / generating version IDs Bnd/maven/.../repository: assembly, deployment, distribution Resolver: dependency resolution, wiring o version matching „Open world“ scenario: – development / release tool extensions „Closed world“ (controlled bundle set): – repository extensions “Humans are already incapable …”
- 8. OBVS: The versioning service Bundle-Name: Apache Felix Bundle Repository Bundle-SymbolicName: org.apache.felix.bundlerepository Bundle-Version: 1.0.1 DynamicImport-Package: org.apache.felix.shell Export-Package: org.osgi.service.obr;version="1.0.0";uses:="org.osgi.framework" Import-Package: org.osgi.framework;version="1.3",org.osgi.service.log; resolution:=optional;version="1.3.0",org.osgi.service.obr;version="1.0" Bnd-LastModified: 1238533562871 OBVS-Reference: 201009071638414 OBVS-Bundle-Version-Orig: 1.4.0 OBVS-Export-Package-Orig: org.osgi.service.obr;version="1.0";uses:="org.osgi.framework" Tool support for the „Open world“ case
- 9. Apache ACE integration (WiP) • Enhanced repository enforces versions • API – extended BundleStore interface – String put(InputStream bundle) • Implementation – generates filename (returned) – stores versioned copy of bundle The „Closed world“ case > vers-ace-demo d:tmporg.apache.felix.fileinstall-0.9.0.jar File successfully stored with name 'org.apache.felix.fileinstall-0.9.0.jar‘ > vers-ace-demo d:tmporg.apache.felix.fileinstall-0.9.2.jar File successfully stored with name 'org.apache.felix.fileinstall-0.10.0.jar‘ > vers-ace-demo d:tmpfileinstall-1.0.0.jar File successfully stored with name 'org.apache.felix.fileinstall-0.10.1.jar'
- 10. Under the hood • Scope: detects and versions syntactical changes on the public interface of packages => bundles • Works on bundle .jar (bytecode) • Checks for subtype relation • Stubs => ignores user-defines packages • Modifies bundle meta-data
- 11. Under the hood loader comparator version generator structure representation (BundleTypes) class repre (JavaTypes) structure representation (BundleTypes) difference base .jar MANIFEST sequel .jar MANIFEST
- 12. What (not) to expect, aka Status • Service: currently in „beta“ – open use, free access – beta testing: failing bundles can be stored • Apache ACE integration: a prototype • Some limitations – changes in imported packages (reconstruction non-trivial) – Declarative Services, "include" and "exclude" directives – Java 5 features (generics, annotations)
- 13. Summary • Tooling for OSGi semantic versioning – package and bundle versions – API and implementation packages – standalone bundles, repositories • OBVS at http://osgi.kiv.zcu.cz/obvs/ • Plans for the future – improve (integrate what’s done) – REST API, tool integration?
- 14. THANK YOU This work was brought to you by: Lukáš Valenta, Tomáš Ptáčník, Jaroslav Plzák, Jarda Bauml, Jiří Kučera, Grant Agency of the Czech Republic, project 201/08/0266 http://osgi.kiv.zcu.cz/obvs/