P2 Inspector

P2 Inspector is a headless Eclipse plugin which exposes a REST interface for inspecting and retrieving the contents of a remote P2 repository.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Java 1.8+

Installing

$ cd com.avojak.webapp.p2.inspector.releng
$ mvn clean package

Artifacts are build in:

com.avojak.webapp.p2.inspector.packaging/target/products/com.avojak.webapp.p2.inspector.product/

Docker

After installing, you can build the Docker image:

$ cd ..
$ docker build --tag avojak/p2-inspector:latest .

Usage

Different executables are provided for various platforms (Windows, macOS, Linux).

Linux Example

$ cd com.avojak.webapp.p2.inspector.packaging/target/products/
$ cd com.avojak.webapp.p2.inspector.product/linux/gtk/x86_64/
$ ./p2-inspector

Docker

$ docker run --rm -p 8081:8081 avojak/p2-inspector:latest

To make a request to the REST service, make a GET request to the /repository endpoint with a url parameter for the desired p2 repository.

For example:

$ curl http://localhost:8081/repository?url=http://example.com

The response will be a JSON object built from the P2Repository model.

P2Repository model:

• name: String
• location: String
• isCompressed: Boolean
• lastModified: Long
• groups: IUGroup[]

IUGroup model:

• name: String
• id: String
• description: String
• copyright: String
• licenses: License[]
• version: String

License model:

• name: String
• body: String
• location: String

Deployment

The recommended method of deployment is via the Docker image, although any of the platform-specific products may also be used.

Build System Configuration

Use of a CI/CD platform requires the following environment variables be set:

• DOCKERHUB_USERNAME
• DOCKERHUB_PASSWORD
• HEROKU_USERNAME
• HEROKU_PASSWORD
• SONATYPE_USERNAME
• SONATYPE_PASSWORD
• HEROKU_API_KEY

PDE Target Definition

Under the Oxygen site:

• Eclipse Project SDK
• Equinox Target Components

Under the Orbit site:

• Byte Buddy Java agent ** Optionally add the source bundle
• Gson: Google Json Library for Java ** Optionally add the source bundle
• Guava: Google Core Libraries for Java ** Optionally add the source bundle
• Hamcrest Library of Matchers
• JAXP XML
• mockito-core ** Optionally add the source bundle
• SLF4J Simple Binding ** Optionally add the source bundle

The resulting source should look like this:

<?xml version="1.0" encoding="UTF-8" standalone="no"?><?pde version="3.8"?><target includeMode="feature" name="com.avojak.webapp.p2.inspector.target">
	<locations>
		<location includeAllPlatforms="false" includeConfigurePhase="true" includeMode="planner" includeSource="true" type="InstallableUnit">
			<unit id="org.eclipse.equinox.sdk.feature.group" version="3.13.4.v20180322-2228"/>
			<repository location="http://download.eclipse.org/releases/oxygen/201804111000"/>
			<unit id="org.eclipse.sdk.feature.group" version="4.7.3.v20180330-0919"/>
		</location>
		<location includeAllPlatforms="false" includeConfigurePhase="true" includeMode="planner" includeSource="true" type="InstallableUnit">
			<unit id="com.google.guava" version="21.0.0.v20170206-1425"/>
			<unit id="com.google.guava.source" version="21.0.0.v20170206-1425"/>
			<unit id="javax.xml" version="1.3.4.v201005080400"/>
			<unit id="org.hamcrest" version="1.1.0.v20090501071000"/>
			<unit id="org.mockito" version="2.23.0.v20181106-1534"/>
			<unit id="org.mockito.source" version="2.23.0.v20181106-1534"/>
			<repository location="http://download.eclipse.org/tools/orbit/downloads/drops/R20181128170323/repository"/>
			<unit id="com.google.gson" version="2.8.2.v20180104-1110"/>
			<unit id="com.google.gson.source" version="2.8.2.v20180104-1110"/>
			<unit id="net.bytebuddy.byte-buddy-agent" version="1.9.0.v20181106-1534"/>
			<unit id="net.bytebuddy.byte-buddy-agent.source" version="1.9.0.v20181106-1534"/>
			<unit id="org.slf4j.binding.simple" version="1.7.10.v20160301-1109"/>
			<unit id="org.slf4j.binding.simple.source" version="1.7.10.v20160301-1109"/>
		</location>
	</locations>
</target>

Built With

• Tycho - Building the Eclipse plugin
• Maven - Dependency management
• Jetty - Embedded web server

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Eclipse Public License v1.0 - see the LICENSE.md file for details.

Acknowledgments

• The structure of this project, and the ability to create a cross-platform, headless Eclipse plugin, was directly inspired by irbull/p2diff