Set up for developers

[hugohills-regnosys]

Rosetta code generators needs set up instructions for developers.

[hugohills-regnosys]

Documentation on dev set up is out of date. Here's an updated set of instructions:

1. Install required dependencies:

• Java 11
• maven
• git

2. Create new folder for your code-gen dev env, e.g. ~/dev/code-gen (on mac) or C:/dev/code-gen (on windows), or whatever path you want. These instructions will refer to the code-gen dev folder as <code-gen>.

3. Set up maven:

• Create new .m2 folder in your <code-gen> folder, e.g. <code-gen>/.m2.
• Copy attached settings.xml file into new .m2 folder, e.g. <code-gen>/.m2/settings.xml.
• In the settings.xml file, update <localRepository> to your new .m2 folder, e.g. <code-gen>/.m2/repository
• Note that no server user or password is required - the code generator dependencies are public.

4. Fork and clone the project in your own workspace, e.g. <code-gen>/github/REGnosys/rosetta-code-generators.

5. Maven clean and install, specifying user settings file (-s), e.g. mvn -s <code-gen>/.m2/settings.xml clean install:

• maven should run successfully with no errors

6. Set up Eclipse:

• Download and install Eclipse IDE for Java and DSL Developers:
  • For earlier Rosetta DSL versions use Eclipse version 2021-12 (contains xtext 2.25.0 and other dependencies). See here.
  • For Rosetta DSL versions after 5.0.0 use Eclipse version 2022-06 (contains xtext 2.27.0 and other dependencies). See here.
• Install the correct Eclipse version. Installing other versions, then updating the xtext plugins is unsupported (but probably possible). You can install multiple Eclipse applications on your computer, so if you have an existing Eclipse installation, you should set up a new, separate install for this.
• Once downloaded and installed, open Eclipse, and create new workspace, e.g. <code-gen>/eclipse-workspace.
• Go to Preferences > Maven > User Settings:
  • Update user settings xml file to new settings.xml, e.g. <code-gen>/.m2/settings.xml
  • Local repository should automatically update to new mvn repository. e.g. <code-gen>/.m2/repository
• Import existing maven project, rosetta-code-generators.
• Run build all; check everything compiles, and all tests run (including all xtend tests).

[hugohills-regnosys]

settings.xml file for rosetta-code-generators dev env (the <localRepository> element must be updated to your local mvn repository inside code-gen-home folder):

Settings.xml removed, see comment below

[tomhealey-icma]

After implementing the above changes the following errors occur:
[ERROR] The project com.regnosys.rosetta.code-generators:parent:0.0.0.master (C:\Users\theal\eclipse-workspace\regnosys\rosetta-code-generators\pom.xml) has 2 errors
[ERROR] Non-resolvable import POM: Could not transfer artifact org.eclipse.xtext:xtext-dev-bom:pom:2.27.0 from/to central (https://regnosys.jfrog.io/regnosys/libs-release): authentication failed for https://regnosys.jfrog.io/regnosys/libs-release/org/eclipse/xtext/xtext-dev-bom/2.27.0/xtext-dev-bom-2.27.0.pom, status: 401 Unauthorized @ line 88, column 25 -> [Help 2]
[ERROR] Non-resolvable import POM: Could not transfer artifact org.junit:junit-bom:pom:5.9.1 from/to central (https://regnosys.jfrog.io/regnosys/libs-release): authentication failed for https://regnosys.jfrog.io/regnosys/libs-release/org/junit/junit-bom/5.9.1/junit-bom-5.9.1.pom, status: 401 Unauthorized @ line 148, column 25 -> [Help 2]

After getting the above errors I found that https://regnosys.jfrog.io/regnosys/libs-release is not public, so I removed the two references in the settings file and the maven build now succeeds.

[hugohills-regnosys]

Hi @tomhealey-icma, thank you for raising out this issue. As you pointed out, the settings.xml in the comment above was missing maven central, so it unable to get a some dependencies.

All dependencies in rosetta-dsl are available in maven central, so the project can be build with the default settings.xml (or by removing the regnosys artifactory entries in the above settings.xml).

However, rosetta-code-generators depends on releases of rosetta-dsl and rosetta-common which are not available in maven central (yet) but in the regnosys artifactory, so the regnosys artifactory needs to be added to the settings.xml.

Here is an updated settings.xml with both central and regnosys repositories that can be used to build rosetta-code-generators.

<?xml version="1.0" encoding="UTF-8"?>
<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"
          xmlns="http://maven.apache.org/SETTINGS/1.1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <localRepository/>
    <profiles>
        <profile>
            <repositories>
                <repository>
                    <id>central</id>
                    <url>https://repo1.maven.org/maven2/</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                </repository>
                <repository>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <id>regnosys-release</id>
                    <name>libs-release</name>
                    <url>https://regnosys.jfrog.io/regnosys/libs-release</url>
                </repository>
                <repository>
                    <snapshots/>
                    <id>regnosys-snapshots</id>
                    <name>libs-snapshot</name>
                    <url>https://regnosys.jfrog.io/regnosys/libs-snapshot</url>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <id>central</id>
                    <url>https://repo1.maven.org/maven2/</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                </pluginRepository>
                <pluginRepository>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <id>regnosys-release</id>
                    <name>plugins-release</name>
                    <url>https://regnosys.jfrog.io/regnosys/libs-release</url>
                </pluginRepository>
                <pluginRepository>
                    <snapshots/>
                    <id>regnosys-snapshots</id>
                    <name>plugins-snapshot</name>
                    <url>https://regnosys.jfrog.io/regnosys/libs-snapshot</url>
                </pluginRepository>
            </pluginRepositories>
            <id>artifactory</id>
        </profile>
    </profiles>
    <activeProfiles>
        <activeProfile>artifactory</activeProfile>
    </activeProfiles>
</settings>

[hugohills-regnosys]

Renamed this issue as it covers set up instructions for all code generators, not just Python.

[dschwartznyc]

Following the revised instructions in order to rebuild the project from the bottom up. The new installation runs successfully via the command line (mvn -s <code-gen>/.m2/settings.xml clean install) but the process fails when run in Eclipse (2021) with an error saying that the tests are not discoverable:

org.junit.platform.commons.JUnitException: TestEngine with ID 'junit-jupiter' failed to discover tests

...

Caused by: org.junit.platform.commons.JUnitException: ClassSelector [className = 'com.regnosys.rosetta.generator.c_sharp.CSharpModelObjectGeneratorTest'] resolution failed
at org.junit.platform.launcher.listeners.discovery.AbortOnFailureLauncherDiscoveryListener.selectorProcessed(AbortOnFailureLauncherDiscoveryListener.java:39)
at org.junit.platform.engine.support.discovery.EngineDiscoveryRequestResolution.resolveCompletely(EngineDiscoveryRequestResolution.java:102)
at
....

Caused by: java.lang.UnsupportedClassVersionError: com/regnosys/rosetta/generator/external/AbstractExternalGenerator has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0

Additionally, do new projects no longer require the following?

mvn archetype:generate -DgroupId=com.regnosys.rosetta.code-generators -DartifactId=python