EmilOvcina / jolievisualize

This tool is a part of my Master's Thesis

Jolievisualize

Visualize and refactor Jolie projects!

The tool is primarily an extension to a vscode plugin so installing this tool separately is not recommended since the refactoring capabilities are not supported without the vscode plugin. Visualization and building are still supported using this without the vscode plugin.

Requirements

• It is required that Jolie, version 1.11.0-git, is set up correctly. Look here for further explanation on how to set up Jolie correctly.

• A JSON configuration file is used for getting information about the top-level services and networks. See the section on how to set up the architecture file.

Installation

Installing the vscode plugin automatically installs this package, but if the tool should be installed without the vscode plugin:

Using NPM:

npm install jolievisualize

Usage

If this tool is being used with the vscode plugin go to the plugin README, else keep reading:

Setting up the config file

Create a file called architecture.jolie.json at the root of the project. Paste this skeleton config JSON into the file:

[
    [
        {"file":"svc.ol", "target":"name", "instances":1}
    ]
]

Change the name and file name to a relevant service name the file which contains the service.

Further configurations of the architecture file can be found under the Architecture JSON File Structure section

Commands

Visualize

npx jolievisualize <path/to/architecture.json>

Generate Development Environment

npx jvbuild <path/to/architecture.json> [path/to/folder] [method]

Default folder: ./build

Default method: docker-compose

Dependencies

When the tool is being used without the vscode plugin, express is used to serve the UI as static assets and an endpoint, /data, is used to get the project data needed for visualization.

Architecture JSON File Structure

The file contains an array of arrays of services. Each array in the enveloping array represents a network.

Example:

[
    [
        {...}, {...}
    ],
    [
        {...}
    ]
]

This means that there are two networks where the first contains two services and the second contains one service.

Service Fields

Here is a table of possible fields for a service:

Field	Description	Type	Example
file	The location of a Jolie file relative to the architecture file	String	main.ol
target	Name of the service in the file	String	MainService
name	Name of the service in the file	String	MainService
instances	Number of instances of the service to be visualized	Long	2
container	Name of the container in the deployment yaml file	String	MainContainer
args	Jolie arguments which gets added to the Dockerfile after building	String	--connlimit 10 --stackTraces
params	Either path to a JSON file containing service parameters, or the parameters as JSON	String or JSON	params.json or { location: "localhost:3432" }
env	Deployment environment variables. Gets added in the deployment yaml file	JSON	{ username: "test", password: "123" }
image	Specifies a remote image which gets added in the deployment yaml file	String	emilovcina/somejolieimage
ports	List of strings defining Docker port mappings	String[]	["4000:4000","3444:9000"]
volumes	List of file locations which will get bound as volumes when running the deployment	String[]	["/config.ini","assets/test.txt"]