INFSOM-RI The Reporting Engine Paolo Fabriani Engineering Ingegneria Informatica S.p.A. 2 nd ETICS All Hands Meeting Bologna – Oct 23-25, 2006

INFSOM-RI Summary The ETICS RepositoryThe ETICS Repository –Artefacts The Report EngineThe Report Engine –Overview, Disseminators, Transformers SamplesSamples –Converters, Aggregators, Pipelines

INFSOM-RI The ETICS Repository The ETICS repositoryThe ETICS repository –A Data Management System thtat allows to store, catalog, manipulate, browse, search and delete ETICS artefacts The ETICS repository containsThe ETICS repository contains –Raw Data –Binary Packages (rpm, tgz, msi, deb, zip,...) –Reports (build reports and logs, test reports,...) –Metadata and relations among artefacts Metadata artefact Repository Service Raw Data (xml) Metadata artefact Refs To Artefacts

INFSOM-RI ETICS Artefacts ETICS ArtefactETICS Artefact –identifier –metadata –data source: packages, reports, logs, custom output,... –accessible through URLs Repository Service Metadata artefact Raw Data (tgz) url Client (Cmd / Web)

INFSOM-RI Scenario Simple ScenariosSimple Scenarios –ETICS Raw Artefact available in HTML format –User wants to get it as PDF –Build Log available as XML –Present it as HTML (given a XSL) –Build Artefact stored as TGZ –Download it as ZIP file Advanced ScenariosAdvanced Scenarios –Produce Aggregate statistics from project-wide build logs

INFSOM-RI Approaches Attach multiple formats, presentations & processings to each artefactAttach multiple formats, presentations & processings to each artefact Repository Service Metadata artefact Raw Data (tgz) Metadata artefact Raw Data (zip)

INFSOM-RI Approaches Attach multiple formats, presentations & processings to each artefactAttach multiple formats, presentations & processings to each artefact Attach parametric transformers to artefact to dynamically produce different formats, presentations & processingsAttach parametric transformers to artefact to dynamically produce different formats, presentations & processings –can be reused to manipulate data of the same type –changes to the source format propagate to derived formats –less content is stored in the repository Repository Service Metadata artefact Raw Data (tgz)... tgz 2 zip tgz 2 xxx

INFSOM-RI Disseminators A Disseminator is a component added to any artefact to produce extended functionality for the artefactA Disseminator is a component added to any artefact to produce extended functionality for the artefact –defines a new access points for the artefact beyond accessing to the artefact itself –identifies a concrete trasformer that provides the functionality Metadata artefact Repository Service Raw Data (XML) PDF Disseminator client interface Transformer Client (Cmd / Web) URL+ params

INFSOM-RI Disseminators (cont’d) –defines a mapping (data & operation) between –the extended access point provided to the artefact (and a number of related artefacts) and –concrete operations & arguments of the transformer –multiple disseminators can be attached to each artefact Metadata Transformer artefact Repository Service Raw Data (XML) PDF Disseminator client interface WS mapping Client (Cmd / Web) URL+ params PostScript

INFSOM-RI Behaviour Definitions and Mechanisms Behaviour Definition (bDef): defines a number of abstract operations (and arguments) that enhances the client-side interface to the artefactBehaviour Definition (bDef): defines a number of abstract operations (and arguments) that enhances the client-side interface to the artefact –e.g. getPrintable(format) Behaviour Mechanism (bMech): registers the capability of a transformer (WS) to perform the operations defined by a bDefBehaviour Mechanism (bMech): registers the capability of a transformer (WS) to perform the operations defined by a bDef –can fix parameters of the plugin (WS) –e.g. Multiple bMech can be registered for (implement) a bDefMultiple bMech can be registered for (implement) a bDef

INFSOM-RI Transformers Implemented as Web ServicesImplemented as Web Services –invoked using URLs (with args) and replying via HTTP responses –SOAP-based WS Web Services have a profile describingWeb Services have a profile describing –endpoint of the service –lists operations –input parameters and output types for each operation –Input/Output can be either simple values (e.g. strings) and artefacts (e.g. jpg images) –Input/Output can be passed by value or reference (e.g. an url to get a zip from the ETICS repository) –Input and outputs can be typed (e.g. MIME types) –used to register the plugin in the system

INFSOM-RI Dissemination Manager Dissemination ManagerDissemination Manager –Registers –Disseminators –Web Services –Defines a mapping between: –Artefact types and disseminators –Artefact instances and disseminators

INFSOM-RI Characterisation InitiatorInitiator –User –via WebApplication or Command Line Interface –The ETICS System –on a scheduled basis or on significant events (e.g. build) StorageStorage –Persistent (until explicit removal) –e.g. time-consuming report generators could permanently be store the report int the ETICS Repository becoming an artefact itself –Volatile (until user retrieval) –Stored in a per-user or shared workspace outside the repository. Accessible via the ETICS dashboard (MyETICS)

INFSOM-RI Characterisation ExecutionExecution –Synchronous –e.g. for quick, single, transformations –Asynchronous –e.g. for time-consuming/mass reports LifetimeLifetime –Limited –when volatile/async –Indefinite –when persistent

INFSOM-RI Sample Scenarios On-demand, synchronous, volatile, format conversionOn-demand, synchronous, volatile, format conversion –User asking for a printable version (PDF) of a build report On-demand, asynchronous, volatile, code analysisOn-demand, asynchronous, volatile, code analysis –User asking for a project-wide, heavy analysis Scheduled / Triggered, persistent report generationScheduled / Triggered, persistent report generation –ETICS Build System triggering the production of aggregate statistics after a build process

INFSOM-RI Sample Transformers Format Converters Report formattingReport formatting –E.g. XML -> HTML Package Format ConversionPackage Format Conversion –e.g. RPM ->tgz Graphs, Barcharts, Plots...Graphs, Barcharts, Plots...

INFSOM-RI Sample Transformers Aggregators IN: build report listing components built for a projectIN: build report listing components built for a project IN: raw quality metrics for each component builtIN: raw quality metrics for each component built OUT: raw quality metrics for the whole projectOUT: raw quality metrics for the whole project OUT: high level quality metricsOUT: high level quality metrics

INFSOM-RI Sample Transformers Pipelines composes several transformers in a pipelinecomposes several transformers in a pipeline enables rapid development of transformers composing existing onesenables rapid development of transformers composing existing ones can be implemented as a pipeline enginecan be implemented as a pipeline engine –customized on a specific pipeline definition that –describes the composition of transformers –maps outputs to inputs T1T2 T3 T4