ART-DECOR building and testing - Revision history

Admin at 10:17, 28 July 2021

2021-07-28T10:17:30Z

Admin at 12:38, 21 May 2021

2021-05-21T12:38:09Z

Show changes

Admin at 18:10, 6 February 2021

2021-02-06T18:10:22Z

Admin at 18:09, 6 February 2021

2021-02-06T18:09:33Z

Mligtvoet at 14:44, 25 October 2018

2018-10-25T14:44:36Z

Mligtvoet: /* Building ART-DECOR packages */

2018-10-25T14:43:00Z

‎Building ART-DECOR packages

Mligtvoet: /* Building ART-DECOR packages */

2018-10-25T14:42:50Z

‎Building ART-DECOR packages

Mligtvoet at 13:40, 25 October 2018

2018-10-25T13:40:53Z

Mligtvoet: /* Orbeon */

2018-10-25T13:37:28Z

‎Orbeon

Mligtvoet: /* Installing a Orbeon war file into a ART-DECOR instance */

2018-10-25T13:36:34Z

‎Installing a Orbeon war file into a ART-DECOR instance

@@ Line 12: / Line 12: @@
 ==Install eXist-db from installer==
 The part will install the eXist-db database.
-First download the ART-DECOR eXist-db installer .jar from:
+A Unix-like OS is assumed, but the main part of the work is done inside eXist-db.
 === Notes on the installation ===
 * Make sure JAVA is installed
 * Mac and Linux can use the .jar installer: java -jar INSTALLER_FILE.jar
-* Please note we build a specific eXist-db installer which contains configuration for ART-DECOR. Details about the configuration can be found at: https://bitbucket.org/art-decor/art-decor-backend/src/exist-db-5/exist5/
+* Please note ART-DECOR uses a specific eXist-db installer which contains configuration for ART-DECOR. Details about the configuration can be found at: https://bitbucket.org/art-decor/art-decor-backend/src/exist-db-5/exist5/
 * Start the database: sudo INSTALLATION_FOLDER/bin/startup.sh or use wrapper scripts for linux (see below)
 * See also the installation process for Linux for older versions: [[ART-DECOR_installation_on_linux]]
@@ Line 46: / Line 45: @@
 systemctl stop exist-db.service
 cd /opt/art-decor-linux/tooling/packages
-VERSION=5.1.1
+# Set the version:
-VERSIONSHORT=511
+VERSION=5.3.0
-# Or run another SNAPSHOT version:
+VERSIONSHORT=530
 # download the ART-DECOR eXist-db installer
 wget https://decor.test-nictiz.nl/pub/exist_art_decor_${VERSION}/exist-installer-${VERSION}_artdecor.jar --no-check-certificate
 # start the eXist-db installer:
@@ Line 99: / Line 97: @@
 * check that there is no other eXist-db currently running
 <syntaxhighlight lang="bash">
-systemctl status exist-db.service
+systemctl status exist-db-${VERSIONSHORT}.service
 ps aux |grep -i exist
 netstat -anp|grep :8080
@@ Line 130: / Line 128: @@
 <syntaxhighlight lang="bash">
 cd /etc/systemd/system
-chown existdb exist-db.service
+chown existdb exist-db-${VERSIONSHORT}.service
-chgrp existdb exist-db.service
+chgrp existdb exist-db-${VERSIONSHORT}.service
 echo eXist-db can be started/stopped/status with:
 echo sudo systemctl status exist-db-${VERSIONSHORT}.service
@@ Line 144: / Line 142: @@
 sudo systemctl daemon-reload
 </syntaxhighlight>
 * check status and logging files
@@ Line 157: / Line 162: @@
 === eXist-db ART-DECOR package installation ===
-In this step we will install the ART-DECOR packages into eXist-db
+In this step we will install the ART-DECOR packages into eXist-db.
 * If needed: Create SSH-tunnel to the server. localhost:8877 to server:8877
-* access eXist-db on http://localhost:8877 with your browser
+* Check the eXist-db logs while you are installing packages below
-* check the eXist-db logs while you are installing packages below
+* Navigate in a browser to http://localhost:8877
+* Access the package manager:
 http://localhost:8877/exist/apps/dashboard/admin#/launcher
 http://localhost:8877/exist/apps/dashboard/admin#/packagemanager
-Update if there are updates (from the eXist-db repository): Dashboard, eXide, shared
+* Change the repository configuration to the ART-DECOR repository
+Browse to eXide: http://localhost:8877/exist/apps/eXide/index.html
-* Install packages from ART-DECOR repository:
+* Open this file: by clicking on '''directory''' and clicking to this location:
 /db/apps/packageservice/configuration.xml
 The default configuration allows you to install/update eXist-db packages from exist-db.org .xar package repository. Note that eXist-db can only handle one repository.
+* Change the repository stanza so that it points to the ART-DECOR .xar package repository (and comment the exist-db.org line out):
 <syntaxhighlight lang="xml">
 <settings>
@@ Line 184: / Line 186: @@
          <repository active="true" default="true">http://decor.nictiz.nl/apps/public-repo-dev5</repository>
 </syntaxhighlight>
-Save
+* File, Save
-* Install ART-DECOR packages with the package manager
+* Access the package manager:
-First install:
+http://localhost:8877/exist/apps/dashboard/admin#/packagemanager
-eXist Module for Schematron validation with SchXslt
+* Install ART-DECOR packages from the ART-DECOR repository with the package manager
 * API documentation:
@@ Line 213: / Line 220: @@
 sudo systemctl start exist-db-${VERSIONSHORT}.service
 </syntaxhighlight>
 ==eXist-db ART-DECOR code update==

@@ Line 1: / Line 1: @@
-{{underconstruction}}
+=Creating a new art-decor.war package=
-This page will document how to build and test ART-DECOR in a automated process.
+Steps to create the art-decor.war package:
-==Building ART-DECOR packages==
+=Creating new .xar packages=
-The following steps are taken during an ART-DECOR build:
+ART-DECOR software is deployed through eXist-db .xar packages with the eXist-db package manager. In order to create these packages, the following files should be present in a subversion software repository:
-* Create new vue build
+* build.xml: contains meta information on the package, and the version number (in major.minor.build form). For packages containing software the minor number is:
-* Create new ART-DECOR packages
+** even for stable releases
-===eXist-db===
+When building .xar packages, a expath-pkg.xml and repo.xml is generated from the .tmpl and build.xml. In subversion there should be a git:ignore so that locally generated expath-pkg.xml and repo.xml are not included in subversion code.
-Documentation on how to run the script for updating the repository can be found here: TODO
+For examples, see: https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/art/
-The result (development) repository is viewable here: http://decor.nictiz.nl/apps/public-repo-dev5/retrieve.html
+For more information on building xars, see: http://exist-db.org/exist/apps/doc/repo.xml
-==Building ART-DECOR instance==
+=Creating a new version of an existing package=
-The following steps are taken during an ART-DECOR instance build:
+* Commit your software code, include an (English) subversion comment that describes your changes.
-* Install or update vue [[ART_developers_vue]]
+* build.xml: increment the build number:
-* install eXist-db
+Example:
-* install ART-DECOR packages
+<syntaxhighlight lang="xml">
-* Restoring data
+    <property name="project.version" value="0.989.32"/>
-===eXist-db===
+=ART-DECOR repositories=
-====eXist-db installation====
+==Production code repository==
-See: [[ART-DECOR_installation_on_linux#eXist-db_installation]]
+For the current production version (ART-DECOR version 2), see: https://bitbucket.org/art-decor/art-decor-backend/src/exist-db-2/
-====Installing .xars into a ART-DECOR instance====
+==Production package repository==
-Documentation can be found here: [[ART-DECOR_installation_on_linux#Install_ART-DECOR_software_.26_data]]
+All ART-DECOR modules are exposed though an eXist-db repository for easy installation. Check modules [https://art-decor.org/repo/list.php here].
-===Restoring data===
+==ART-DECOR Next generation code repository==
-Test instances or production instances of ART-DECOR might need data restored into their database.
+From ART-DECOR version 3 and onwards:
-==Testing ART-DECOR==
+* Vue-client front-end: (should be used in combination with Back-end database)
-Tests that can be run against a ART-DECOR instance are documented at:
+https://bitbucket.org/art-decor/art-decor/
-[[ART_developers_manual#ART-DECOR_testscenarios]]
+* Back-end database:

@@ Line 4: / Line 4: @@
 ==Building ART-DECOR packages==
 The following steps are taken during an ART-DECOR build:
+* Create new vue build
-[[File:Build_packages.jpg|220px]]
+* Create new ART-DECOR packages
 ===eXist-db===
 ====Commit code====
-Code is committed in a software repository and 2 logs are created:
+Code is committed in a software repository, see [[ART_developers_manual#ART-DECOR_Next_generation_repository]]
 ====Build .xar packages====
 During this step code from the code repository is converted into .xar packages.
@@ Line 20: / Line 15: @@
 Documentation on how to run the script for updating the repository can be found here: TODO
-The result repositories are viewable here: [[Download#Repository]]
+The result (development) repository is viewable here: http://decor.nictiz.nl/apps/public-repo-dev5/retrieve.html
 ==Building ART-DECOR instance==
 The following steps are taken during an ART-DECOR instance build:
+* Install or update vue [[ART_developers_vue]]
-[[File:Build_instance.jpg|420px]]
+* install eXist-db
-====Using docker====
+* install ART-DECOR packages
-There is a docker script that will deploy a running instance of ART-DECOR that contains:
+* Restoring data
 ===eXist-db===
@@ Line 57: / Line 33: @@
 ===Restoring data===
 Test instances or production instances of ART-DECOR might need data restored into their database.
 ==Testing ART-DECOR==
 Tests that can be run against a ART-DECOR instance are documented at:
 [[ART_developers_manual#ART-DECOR_testscenarios]]

@@ Line 23: / Line 23: @@
 ==Building ART-DECOR instance==
 ====Using docker====
 There is a docker script that will deploy a running instance of ART-DECOR that contains:

@@ Line 5: / Line 5: @@
 The following steps are taken during an ART-DECOR build:
-[[File:Build_packages.jpg|250px]]
+[[File:Build_packages.jpg|220px]]
 ===Orbeon===
 ====Creating a Orbeon .war file====

@@ Line 43: / Line 43: @@
 ===Orbeon===
 ====Installing a Orbeon war file into a ART-DECOR instance ====
 Documentation can be found here: [[ART-DECOR_installation_on_linux#Apache_Tomcat_installation]]