Uploaded image for project: 'RAML Module Builder'
  1. RAML Module Builder
  2. RMB-130

Use target/generated-sources for generated code

    XMLWordPrintable

Details

    Description

      Currently RMB places generated code into
      src/main/java/org/folio/rest/jaxrs

      This should be changed to
      target/generated-sources/raml-jaxrs/org/folio/rest/jaxrs

      Reasons:

      Using target/generated-sources is the commonly used directory for java files that are fully autogenerated:
      https://confluence.jetbrains.com/display/IDEADEV/Maven+Integration+FAQ#MavenIntegrationFAQ-GeneratedSources
      http://www.antlr.org/api/maven-plugin/latest/
      https://github.com/mulesoft-labs/raml-jaxrs-codegen/blob/e28c10b/maven-plugin/src/main/java/org/raml/jaxrs/codegen/maven/RamlJaxrsCodegenMojo.java#L60
      https://www.jooq.org/doc/3.10/manual/code-generation/codegen-configuration/#N49CB2

      IDEs support this directory and warn if one tries to edit the autogenerated java file.

      mvn clean will delete the directory automatically.

      src/main/java/org/folio/rest/.gitignore containing "jaxrs/" is no longer required.

      Code coverage doesn't take target/generated-sources into account. This is correct. (However, the module of the code generator must thoroughly unit test the generated code.)

      Generating the code to src/ already has caused some issues:
      https://issues.folio.org/browse/RMB-115
      https://issues.folio.org/browse/DMOD-23
      https://issues.folio.org/browse/DMOD-24
      https://issues.folio.org/browse/DMOD-138
      https://issues.folio.org/browse/DMOD-141

      TestRail: Results

        Attachments

          Issue Links

            blocks

            New Feature - New feature requests FOLIO-1049 Reject pull request if new code doesn't pass sonar's quality gate (backend modules)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Open

            Task - A task that needs to be done. FOLIO-1076 Make SQ ignore generated sources

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed
            relates to

            Task - A task that needs to be done. CIRCSTORE-43 Upgrade to RAML Module Builder version 19.0.0

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. DIMPT-4 Update RMB for generated-sources directory

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Task - A task that needs to be done. MODCXMOCK-16 Update to RMB 19.0.0 (target/generated-sources)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Task - A task that needs to be done. MODCXMUX-20 Update to RMB 19.0.0 (target/generated-sources)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Task - A task that needs to be done. MODINVSTOR-65 Upgrade to RAML Module Builder version 19.0.0

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Task - A task that needs to be done. MODNOTES-35 Update to RMB 19.0.0 (target/generated-sources)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Task - A task that needs to be done. MODNOTIFY-22 Update to RMB 19.0.0 (target/generated-sources)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Task - A task that needs to be done. MODUSERBL-24 Update to RMB 19.0.0 (target/generated-sources)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Sub-task - The sub-task of the issue RMB-142 Update mod-rmb-template POM configuration to use target/generated-sources

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. RMB-140 move to v19, 18.0.1 requires entry in pom

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            Activity

              People

                julianladisch Julian Ladisch
                julianladisch Julian Ladisch
                shale99 shale99
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases