Allow injecting maven settings in JDT LS sidecar

[l0rd]

Is your enhancement related to a problem? Please describe.

The problem has been originally described by #14343. It's currently not possible to specify, in a devfile, maven settings that would be taken into account by the LS.

Describe the solution you'd like

We can implement a mechanism that would:

• generate a custom settings.xml in the sidecar
• specify the settings.xml path in the LS preferences java.configuration.maven.userSettings

That maybe done by a plugin init container (mechanism that should be introduced by #13387) that would look for MAVEN_OPTS environment variable (#14343 should be addressed first) and generate the settings.xml.

Describe alternatives you've considered

Another simpler solution that may work would be to pre-package the JDT.LS sidecar image with a settings.xml file:

  <mirrors>
    <mirror>
      <url>${env.MAVEN_MIRROR_URL}</url>
    </mirror>
  </mirrors>

Settings the environment variable MAVEN_MIRROR_URL for the ChePlugin would do the trick then (#14343 need to be fixed first).

[l0rd]

cc @kameshsampath

[fbricon]

indeed, starting the container with a custom settings.xml, defining a mirror (or not) and the local repository with something like <localRepository>${env.MAVEN_LOCAL_REPO}</localRepository> would work. The script starting the container needs to ensure to set the environment variables with default values (same as Maven) or bad things might happen.

cc @tsmaeder

[kameshsampath]

We can default to maven central for the variable? Get Outlook for iOS<https://aka.ms/o0ukef>

…

________________________________ From: Fred Bricon <notifications@github.com> Sent: Friday, August 30, 2019 2:57:57 PM To: eclipse/che <che@noreply.github.com> Cc: Kamesh Sampath <kamesh.sampath@hotmail.com>; Mention <mention@noreply.github.com> Subject: Re: [eclipse/che] Allow injecting maven settings in JDT LS sidecar (#14391) indeed, starting the container with a custom settings.xml, defining a mirror (or not) and the local repository with something like <localRepository>${env.MAVEN_LOCAL_REPO}</localRepository> would work. The script starting the container needs to ensure to set the environment variables with default values (same as Maven) or bad things might happen. cc @tsmaeder<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Ftsmaeder&data=02%7C01%7C%7Cd4b6389fca224996469008d72d2c5801%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637027540781287584&sdata=quSy%2B2h120DVlBzzrgQAW%2BN8YKNMhM6KRv5AGZPy9Qo%3D&reserved=0> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Feclipse%2Fche%2Fissues%2F14391%3Femail_source%3Dnotifications%26email_token%3DAAHHMIJILEAGRX2M363QOW3QHDRZ3A5CNFSM4ISHQBHKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5RD5TQ%23issuecomment-526532302&data=02%7C01%7C%7Cd4b6389fca224996469008d72d2c5801%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637027540781297593&sdata=rWbVxIsGJ8aSqrCRbQdMR13cpkdjr246xPkqulE6m2w%3D&reserved=0>, or mute the thread<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAHHMIIEH5LJ33TLZKD6XNDQHDRZ3ANCNFSM4ISHQBHA&data=02%7C01%7C%7Cd4b6389fca224996469008d72d2c5801%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637027540781307603&sdata=hrC%2BV4nvUsfq3a8ysUMUR9PVfQngI65UJqIwh42guQc%3D&reserved=0>.

[fbricon]

if MAVEN_MIRROR_URL is not present, the settings.xml should not define the mirror

[kameshsampath]

yeah thats what we do currently in most . of the openshift images via entrypoint scripts

[tolusha]

The resulted settings.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <mirrors>
    <mirror>
      <url>${env.MAVEN_MIRROR_URL}</url>
      <mirrorOf>central</mirrorOf>
    </mirror>
  </mirrors>
</settings>

[tolusha]

@fbricon I am wonder if <mirrorOf>central</mirrorOf> won't break anything.

[kameshsampath]

IMHO no but we can make like <mirrorOf>external:*</mirrorOf> to make it better for all external repos as the current one will work only for maven central, WDYT @fbricon? Get Outlook for iOS<https://aka.ms/o0ukef>

…

________________________________ From: Anatoliy Bazko <notifications@github.com> Sent: Thursday, September 5, 2019 10:17:55 PM To: eclipse/che <che@noreply.github.com> Cc: Kamesh Sampath <kamesh.sampath@hotmail.com>; Mention <mention@noreply.github.com> Subject: Re: [eclipse/che] Allow injecting maven settings in JDT LS sidecar (#14391) @fbricon<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Ffbricon&data=02%7C01%7C%7C45a52fae375c411e52cb08d7320bd923%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637032898773800386&sdata=XXSx0PtdEmzYbeXSO%2Bg%2BkfKpyod3voC0uHc5oEOSC4Y%3D&reserved=0> I am wonder if <mirrorOf>central</mirrorOf> won't break anything. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Feclipse%2Fche%2Fissues%2F14391%3Femail_source%3Dnotifications%26email_token%3DAAHHMILRVWJDJGQ5NRLMAHLQIEIJHA5CNFSM4ISHQBHKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD57IPEI%23issuecomment-528385937&data=02%7C01%7C%7C45a52fae375c411e52cb08d7320bd923%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637032898773800386&sdata=hOR9OWfdStFrRzVbEof%2FmkwQNAQh7gnggbJLGhPFXLM%3D&reserved=0>, or mute the thread<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAHHMIMUWWW44FWYSSORRJ3QIEIJHANCNFSM4ISHQBHA&data=02%7C01%7C%7C45a52fae375c411e52cb08d7320bd923%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637032898773810394&sdata=3oYXOTOf2zrUspJb6JctShftqjoL9K%2FW%2F78xnhANMLg%3D&reserved=0>.