Programmatically making M2Doc generated docs

btnoecker · 11 November 2023 00:29

Trying to make multiple docs and replacing a single variable in each, the goal is to do so without going through the template and renaming the element being used can creating a new doc to save. Was planning on doing so via python scripts but is there a way to do so via the command line? (open to other suggestions)

Thank you

YvanLussaud · 13 November 2023 08:08

There is a Capella command line tool to launch the generation of a .genconf file in the M2Doc Capella extensions. It works like the Python4Capella one if you have a Team for Capella environment.

You can launch it with the following command:

capella.exe -nosplash -consolelog -application org.polarsys.capella.core.commandline.core -appid org.obeonetwork.capella.m2doc.commandline -filepath project/myGeneration.genconf -data ./workspace -outputfolder /project/generated -forceoutputfoldercreation

If you want to generate documents programmatically you can also have a look at the documentation.

btnoecker · 15 November 2023 00:13

Thank you for the command. I was looking at the documentation for generating automatically but I was confused on how to use it through java as it is in the documentation. I was trying to figure out how to develop in java, is there an easier way to learn to programmatically create the generation code, because I’m not sure how to use the java code given in the documentation. May be a simple answer but it has me quite confused.

btnoecker · 15 November 2023 02:44

Also, when I run that command, the Capella terminal window pops-up but shuts-down after a second after it tries generating. Is there somewhere I can see the error log to see what is causing it to close/crash?

YvanLussaud · 15 November 2023 08:01

If you want to launch your generation form a .genconf file you might also use this method as a starting point.

The log should be in the console when you use -consolelog… but you should also find a file in the workspace workspace/.metadata/.log.

btnoecker · 17 November 2023 18:21

Not sure what to make of this error message, here is the command and log info (I also chan):

Command:
capella.exe -nosplash -consolelog -application org.polarsys.capella.core.commandline.core -appid org.obeonetwork.capella.m2doc.commandline -filepath ./workspace/In-Flight Entertainment System With M2Doc/Template LA Complete.genconf -data ./workspace -outputfolder ./workspace/In-Flight Entertainment System With M2Doc/generated -forceoutputfoldercreation

(also tried changing names to avoid spaces in path names):
capella.exe -nosplash -consolelog -application org.polarsys.capella.core.commandline.core -appid org.obeonetwork.capella.m2doc.commandline -filepath C:/Apps/capella/workspace/FES-M2Doc/TemplateLA.getconf -data C:/Apps/capella/workspace/FES-M2Doc -outputfolder C:/Apps/capella/workspace/FES-M2Doc/generated -forceoutputfoldercreation

Error:
java.lang.NullPointerException: Cannot invoke “org.obeonetwork.capella.m2doc.commandline.M2DocCommandLinePlugin$Implementation.log(Object)” because the return value of “org.obeonetwork.capella.m2doc.commandline.M2DocCommandLinePlugin.getPlugin()” is null

YvanLussaud · 20 November 2023 08:19

Do you have the complete stack trace ? There is an exception because we try to log something…

btnoecker · 8 December 2023 17:11

The complete stack trace for the above error:

	at org.obeonetwork.capella.m2doc.commandline.M2DocCommandLine.execute(M2DocCommandLine.java:119)
	at org.polarsys.capella.core.commandline.core.CommandLineApp.launchApp(CommandLineApp.java:138)
	at org.polarsys.capella.core.commandline.core.CommandLineApp.start(CommandLineApp.java:72)
	at org.eclipse.equinox.internal.app.EclipseAppHandle.run(EclipseAppHandle.java:203)
	at org.eclipse.core.runtime.internal.adaptor.EclipseAppLauncher.runApplication(EclipseAppLauncher.java:134)
	at org.eclipse.core.runtime.internal.adaptor.EclipseAppLauncher.start(EclipseAppLauncher.java:104)
	at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:401)
	at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:255)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.eclipse.equinox.launcher.Main.invokeFramework(Main.java:654)
	at org.eclipse.equinox.launcher.Main.basicRun(Main.java:591)
	at org.eclipse.equinox.launcher.Main.run(Main.java:1462)

YvanLussaud · 11 December 2023 08:57

The .genconf file can’t be loaded. Maybe try an URI in the form file:///C:/... or file:///home/... also if you have spaces in the path try to surround the URI with double quote. You can also try to replace spaces with %20 (URI escape).

dsryzhov · 1 April 2024 13:23

It’s not possible to use absolute file path to genconf (file:///) .
Only workspace path is possible with current realization of M2DocCommandLine

github.com

ObeoNetwork/Capella-Extensions/blob/master/plugins/org.obeonetwork.capella.m2doc.commandline/src/org/obeonetwork/capella/m2doc/commandline/M2DocCommandLine.java

/*******************************************************************************
 * Copyright (c) 2020, 2023 Obeo.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 * 
 * Contributors:
 *     Obeo - initial API and implementation
 *******************************************************************************/
package org.obeonetwork.capella.m2doc.commandline;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;

This file has been truncated. show original

platform type is added to the genconf file provided
genconfs[0] = “platform:/resource/” + CommandLineArgumentHelper.getInstance().getFilePath();

YvanLussaud · 2 April 2024 07:43

I thought is was strange to compute the URI this way, but I think for the Capella session to open the URI needs to be a platform URI. And the aird URI is computed with the genconf URI…

dsryzhov · 2 April 2024 08:25

After some time I’ve returned to the thought of using docker to build documentation using m2doc. Before I had docker image already that was created manually by installing different packages. Now I’ve created dockerfile that can be used to create docker image for m2doc using docker build. It works. I will share it soon. But it needs capella workspace with imported projects to build documentation. And it’s not good. It would be great to have possibility to clone repo from git and start build documentation without the need to create Capella workspace (in Jenkins, for example)

dsryzhov · 2 April 2024 09:16

made test modification to M2DocCommandLine and was able to publish doc without prepared
capella workspace

In details:

for test changed in M2DocCommandLine to
genconfs[0] = CommandLineArgumentHelper.getInstance().getFilePath();
i.e. removed “platform:/resource/” +
and rebuild CapellaExtensions repository
in command line arguments used -data pointing to non existing folder for capella workspace
in command line arguments used -filepath with absolute path to genconf
file:///publish/genconfs/relative.genconf
in genconf used relative paths to capella and aird file

YvanLussaud · 2 April 2024 09:23

You are inserting diagrams from Capella in your M2Doc template ?

dsryzhov · 2 April 2024 09:28

Yes. And diagram were successfully published in this test.

YvanLussaud · 2 April 2024 09:48

Can you open a PR so I can merge this change please ?

dsryzhov · 2 April 2024 10:50

Ok, I will create PR.

dsryzhov · 2 April 2024 15:16

Created PR

github.com/ObeoNetwork/Capella-Extensions

Enable absolute path to genconf in command line arguments.

ObeoNetwork:master ← dsryzhov:abs_genconf_cmdline

opened 03:15PM - 02 Apr 24 UTC

dsryzhov

+1 -1

This PR concern with arguments handling when launching m2doc publishing from com…mand line. Currently it’s not possible to use absolute file path to genconf (file:///) . It's possible to use only workspace path with current realization of M2DocCommandLine. As a result it's not possible to launch publication without workspace creation and project import to it. It's not good for use case when m2doc command line publishing is used in automatic scripts (in Jenkins for example) In the current realization platform type “platform:/resource/” is added to the genconf file path provided in command line arguments genconfs[0] = “platform:/resource/” + CommandLineArgumentHelper.getInstance().getFilePath(); This line needs to be changed to genconfs[0] = CommandLineArgumentHelper.getInstance().getFilePath(); After that absolute path usage to genconf in command line arguments becomes also possible. file:///publish/capella_project/genconfs/test.genconf In this case -data arguments can point to non existing folder for new eclipse workspace or to the existing one (event without projects imported). When absolute path to genconf is used relative paths to aird and capella files should be used inside genconf file. I've tested this modification. Document with diargams was successfully published based on absolute path to genconf. This modification has a side effects. After this modification users should used “platform:/resource/” prefix in command line arguments to genconf file when path is defined relative to workspace. Previous workspace paths (without platform:/resource/) will not continue to work. So this modification crashes existing command line API. May be we need to add platform:/resource/ in the code in case file:/// is not used for genconf to save current API.