CRCE is an experimental repository, designed to support research into component-based and modular systems undertaken by ReliSA research group at the Faculty of Applied Sciences, University of West Bohemia (http://relisa.kiv.zcu.cz). The older project website is over at Assembla: https://www.assembla.com/spaces/crce/wiki .
To cite CRCE as a research result, please use the following citation:
P.Brada and K.Jezek, “Repository and Meta-Data Design for Efficient Component Consistency Verification,” Science of Computer Programming, vol. 97, part 3, pp. 349–365, 2015. Available: http://www.sciencedirect.com/science/article/pii/S0167642314002925
- JDK 11 set in
JAVA_HOMEenvironment variable before starting CRCE, tested on OpenJDK 11.0.4 - MongoDB, tested on v2.6.10, v3.4.10
- Maven 3, tested on 3.5.2
On linux, switching JDK version for development/build can be done via sudo update-java-alternatives (or, less ideal as it does not set all aspects of the environment, sudo update-alternatives --config java).
Mongo DB can either be run locally or in docker using sudo docker run -d -p 27017:27017 -v ~/data:/data/db mongo, where ~/data is directory on host machine to be used as a storage by Mongo.
Some CRCE plugins use a mathematical solver, for which you need to install lpsolve library to your computer. To do that, follow their guide step by step. Note that on Windows, you do not have to place the libs to \WINDOWS or \WINDOWS\SYSTEM32 as the guide states. Put it wherever you wish and add the directory to your Path.
Build process consists of two parts. Compiling and building the code itself and building the docker image.
On linux or similar, the ./build-code.bash script in project root directory can be used to perform these build steps. See top of script source for parameters tweaking the build.
crce-parentin/pomdirectoryshared-build-settingsin/build- everything in
/third-party(bash:.../third-party$ for d in * ; do cd $d; mvn clean install; cd .. ; done) crce-core-reactorin/corecrce-modules-reactorin/modulesprovision-reactorin/deploy
In case of maven error "Received fatal alert: protocol_version", use mvn -Dhttps.protocols=TLSv1.2 ... after https://stackoverflow.com/a/50924208/261891. Forbidden hack to speed up build: -Dmaven.test.skip=true.
Docker image is placed in directory /deploy but before it can be used, bundles must be collected by running the following commands in /deploy directory:
mvn clean pax:directory
./prepare-bundles.sh
The prepare-bundles.sh script is needed due to the issues further described in the Issues section.
To finally build the image itself, execute the following command in /deploy directory:
docker build . -t ${image-tag}To start on local machine, make sure the /deploy/conf folder exists and contains all important configuration (especially the cz.zcu.kiv.crce.repository.filebased-store.cfg. After that, you run CRCE using Maven plugin for pax in crce-modules-reactor module (i.e. /deploy directory):
mvn pax:provision
Assuming the image is build and Mongo DB is running at an accessible address, CRCE can be run in docker by this command:
docker run -it \
-p 8080:8080 \
--add-host mongoserver:172.17.0.1 \
-v /felix/deploy:/felix/deploy \
<image-tag>
The --add-host ... and -v ... parameters allow docker to connect to MongoDB (so use the correct IP address instead of the 172.17... above) and to install new bundles (from the provided directory). If MongoDB is running locally on 127.0.0.1, add --network="host" to make localhost accessible.
The -p parameter maps the port of docker virual machine to the real port on the computer.
The --add-host allows docker to connect to the Mongo database running locally (Docker usually uses 172.17.0.1 ip to access localhost from the container). The app expects the database to be listening on port 27017 by default.
The -v parameter maps directory in container to the real directory in the host machine so that it can be used to install new bundles via CLI.
For the simple case of starting the (above) freshly built image on localhost, use
docker run -it --network="host" --add-host mongoserver:127.0.0.1 <image-tag>
If everything works, the output log should write up some info about dependencies terminated by lines similar to the following:
Listening for transport dt_socket at address: 65505
____________________________
Welcome to Apache Felix Gogo
g! X 10, 2017 10:38:47 DOP. org.glassfish.jersey.server.ApplicationHandler initialize
INFO: Initiating Jersey application, version Jersey: 2.9.1 2014-06-01 23:30:50...
At the moment, a bunch of errors will probably come up:
[Fatal Error] :1:1: Content is not allowed in prolog.
The cause of the latter is a badly loaded binary of mathematical solver which does not affect common application run. Any other error/exception (typically OSGi complaining about a thing) is a problem that needs to be examined as such. However, it should not happen with this version.
Started up, the application is accessible at:
- web UI: http://localhost:8080/crce-webui
- REST web services: http://localhost:8080/rest/v2/
Updated (more or less) REST WS documentation is available at Apiary. Basic endpoints: metadata/<id> (XML), resources (list all), resources/<id> (download one).
Remote debugging is possible when running CRCE in Docker. To enable remote debug, application needs to be started with following flags:
-Xdebug -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005And expose the port 5005 by adding -p 5005:5005 to the docker run command.
Check the deploy/Dockerfile to see the difference between running the app in normal and debug mode.
After modifying a part of code, only the parental module needs to be rebuilt (no need to rebuild all). After that, the pax process must be restarted.
Configuration is done via OSGI service called Configuration Admin. Details on how it's implemented in Felix can be found in Apache Felix Configuration Admin Service.
By default, Felix will look into the config directory for possible configuration (example of such directory can be found in deploy/conf.default)
Some bundles (mostly those from the third parties) either require a particular version of OSGi runtime environment or require the capability osgi.ee to be set to a specific value. This may or may not work with newer version of Java and to avoid runtime problems, these requirements need to be removed.
To remove them, it is necessary to edit manifest (META-INF/MANIFEST.MF) of such bundle and remove lines containing:
Require-Capability: osgi.ee; or Bundle-RequiredExecutionEnvironment: J2SE-. This is done in the deploy/prepare-bundles.sh script.
An ideal solution would be to either find newer versions of such bundles or replace them with different bundles with same functionality. This however may introduce compatibility issues (as some other bundles may depend on the current versions) or may not even be possible (replacement bundle does not exist).
An interim fix is to use /deploy/prepare-bundles.sh as described above which strips the requirements from the manifest files.