Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add UpgradeSettingsCommandlet for the upgrade of legacy devonfw-ide settings to IDEasy #759

Closed
10 of 11 tasks
hohwille opened this issue Nov 13, 2024 · 1 comment · Fixed by #820
Closed
10 of 11 tasks

Add UpgradeSettingsCommandlet for the upgrade of legacy devonfw-ide settings to IDEasy #759

hohwille opened this issue Nov 13, 2024 · 1 comment · Fixed by #820
Assignees
@hohwille @jan-vcapgemini
Labels
configuration should be configurable or configuration change enhancement New feature or request settings ide-settings repo and replated processes and features
Milestone
release:2025.01.001

Comments

@hohwille
Copy link
Member

hohwille commented Nov 13, 2024 •
edited
Loading

As a IDEasy user comming from a devonfw-ide project, I want to have a command to upgrade my settings from devonfw-ide to IDEasy so that I can get rid of all legacy after all my team members have already switched to IDEasy.

An UpgradeSettingsCommandlet shall be added so I can run ide upgrade-settings to upgrade my settings:

  • all devon.properties are renamed to ide.properties. In case a corresponding ide.properties already exists, the config from the devon.properties is merged into the existing ide.properties where ide.properties is the new one and therefore has priority if different values for the same property are defined in both files, the one from devon.properties is ignored/lost. This not only applies to settings but also to conf and all workspaces.
  • We ensure all legacy variables in ide.properties are replaced with their new name (if both legacy and new variable name is defined, the legacy one is removed).
  • Duplicated variables in the same ide.properties are removed (only the last occurrence is kept).
  • If variable DEVON_IDE_CUSTOM_TOOLS exists, it is converted into a ide-custom-tools.json file in settings and the variable is removed (see here and legacy).
  • if settings/devon folder exists, it is renamed to settings/templates
  • UpgradeSettingsCommandlet: settings/templates/conf/.m2 #807
  • if settings/projects folder exists, it is renamed to settings/repositories
  • we recursively traverse all files in settings/workspace and settings/*/workspace and replace all known IdeVariables from CURLY into ANGLED syntax and legacy variable names are replaced with their new names. So e.g. ${DEVON_IDE_HOME} is replaced with $[IDE_HOME] or ${MAVEN_VERSION} is replaced with $[MVN_VERSION]. We also need to replace ${SETTINGS_PATH} with $[IDE_HOME]/settings.
  • if we hit an xml file that is not containing the XML namespace of our merger, we print a warning with the filepath saying that this file is most-likely outdated and print a link to a documentation page about this settings migration feature and linking to our XML merger docs in configurator and telling the project to sync their workspace config manually with the official ide-settings git repo on github provided by us as template for the settings.
  • that documentation page needs to exist and open when I click the link from that warning and explain the migration from devonfw-ide to IDEasy.
  • if settings/ide.properties does not contain IDE_VARIABLE_SYNTAX_LEGACY_SUPPORT_ENABLED=false it will be added.
  • if a replacement-patterns.properties is found in a workspace folder a warning will be logged if the file is not empty and the file will be deleted.

General note:

  • Whenever it says a folder shall be renamed, it must be ensured that the new name does not already exist. Otherwise the rename should not take place and a warning must be logged.
@hohwille hohwille added the enhancement New feature or request label Nov 13, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in IDEasy board Nov 13, 2024
@hohwille hohwille added settings ide-settings repo and replated processes and features configuration should be configurable or configuration change labels Nov 13, 2024
@KianRolf KianRolf self-assigned this Nov 19, 2024
@KianRolf KianRolf moved this from 🆕 New to 🏗 In progress in IDEasy board Nov 19, 2024
@leonrohne27 leonrohne27 self-assigned this Nov 19, 2024
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 19, 2024
@leonrohne27
devonfw#759:
4602866
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 20, 2024
@KianRolf
devonfw#759: listchildrenrecursive
50b9fb2
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 20, 2024
@leonrohne27
devonfw#759: rename
07ae66e
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 20, 2024
@KianRolf
devonfw#759: check
709cb34
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 20, 2024
@leonrohne27
devonfw#759: delete devon.properties
ad841a9 
delete devon.properties if ide.properties already exists in same directory
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 21, 2024
@leonrohne27
devonfw#759
09ecb53
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 21, 2024
@leonrohne27
devonfw#759
9a6d662
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 22, 2024
@leonrohne27
devonfw#759: adjusted EnvironmentCommandletTest
790bf65 
Removed testThatHomeIsRequired in EnvironmentCommanletTest
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@leonrohne27
devonfw#759: Added CheckIfLegacyFolderExists() method
72a720c 
Added a method that checks if legacy folder exists and renames them
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@KianRolf
devonfw#759: combine
47b8ead
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@KianRolf
devonfw#759
a2e3ca9
@hohwille hohwille mentioned this issue Nov 25, 2024
Closed
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@leonrohne27
devonfw#759:
374a059
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@leonrohne27
devonfw#759: Added recursive variable replacement
af2842e 
Added 2 methods that replace all legacy IdeVariables with updated ones, e.g ${DEVON_IDE_HOME} to $[IDE_HOME]
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@leonrohne27
devonfw#759: Added method that deletes file
78c2fad 
Added A method that deletes a 'replacement-patterns.properties' -file, if it exists
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@KianRolf
devonfw#759: merge
c51ef83
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@KianRolf
devonfw#759:small fix
c5c4324
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 25, 2024
@leonrohne27
devonfw#759
bb0c401
@hohwille
Copy link
Member Author

For the record: ide upgrade-settings is a planned feature to move a devonfw-ide project to IDEasy.
In this context also bugs like #808 are relevant to be aware of...

leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 26, 2024
@leonrohne27
devonfw#759: Added checkForXMLNameSpace()-method
d8d2a81 
added a method that reads out and checks all .xml files in settings/*/workspaces for the namespace. If not found, a warning is printed.
leonrohne27 added a commit to leonrohne27/IDEasy that referenced this issue Nov 26, 2024
@leonrohne27
devonfw#759
1a55e15
KianRolf added a commit to leonrohne27/IDEasy that referenced this issue Nov 27, 2024
@KianRolf
devonfw#759: custom-json-file
8fad8d0
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 8, 2025
@hohwille
devonfw#759: refactored updateProperties and custom-tools.json
d607fa6 
replaced regex parsing with indexOf
added JsonIgnores and JsonProperties to CustomTool
converted version from versionIdentifier to String
added Tool record to CustomToolsJson
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 8, 2025
@hohwille
devonfw#759: fix NPE
6e087c3 
replaced regex parsing with indexOf
added JsonIgnores and JsonProperties to CustomTool
converted version from versionIdentifier to String
added Tool record to CustomToolsJson
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 8, 2025
@hohwille
devonfw#759: cleanup to resolve review feedback
8545343 
replaced regex parsing with indexOf
added JsonIgnores and JsonProperties to CustomTool
converted version from versionIdentifier to String
added Tool record to CustomToolsJson
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 8, 2025
@hohwille
devonfw#759: final fixes and test improvements
d37a005 
added JsonIgnores and JsonProperties to CustomTool
converted version from versionIdentifier to String
added Tool record to CustomToolsJson
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 8, 2025
@jan-vcapgemini
devonfw#759: fixed test
730d826 
added missing settings.xml to devon/conf folder
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@hohwille
devonfw#759: also update legacy editions
e1f6071 
added missing settings.xml to devon/conf folder
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@hohwille
devonfw#759: fixed test by adding missing conf due to .gitignore
52e98b8 
added missing settings.xml to devon/conf folder
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@jan-vcapgemini
devonfw#759: optimized tests
cb81b78 
replaced File readString with actual CustomToolJson assert
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@hohwille
devonfw#759: completed last things (*.properties in ~)
1307d33
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@hohwille
devonfw#759: replacement-patterns.properties was deleted and then tri…
323bcc4 
…ed to merge leading to error
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@hohwille
devonfw#759: fix log message
1ee9951
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 9, 2025
@hohwille
devonfw#759: completed (.m2 to mvn)
db02a0c
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 10, 2025
@jan-vcapgemini
devonfw#759: added more tests
d78dbc2 
fixed typo
added test of convert to CustomToolsJsonMapperTest
@jan-vcapgemini jan-vcapgemini changed the title Create UpgradeSettingsCommandlet Create UpgradeSettingsCommandlet to support the update of legacy devonfw-ide settings Jan 10, 2025
@jan-vcapgemini jan-vcapgemini changed the title Create UpgradeSettingsCommandlet to support the update of legacy devonfw-ide settings Create UpgradeSettingsCommandlet to support the upgrade of legacy devonfw-ide settings Jan 10, 2025
@jan-vcapgemini jan-vcapgemini changed the title Create UpgradeSettingsCommandlet to support the upgrade of legacy devonfw-ide settings Add UpgradeSettingsCommandlet for the upgrade of legacy devonfw-ide settings to IDEasy Jan 10, 2025
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 10, 2025
@jan-vcapgemini
devonfw#759: adjusted changelog
60e0901
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 10, 2025
@jan-vcapgemini
devonfw#759: optimized tests
7126cf9 
replaced duplicated tests of CustomToolMetadata
made tests more robust
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 10, 2025
@jan-vcapgemini
devonfw#759: fixed typo
5c9c80b
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 13, 2025
@jan-vcapgemini
devonfw#759: implemented requested changes
0056345 
added default implementation for remove method
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 13, 2025
@jan-vcapgemini
devonfw#759: cleanup
2632801 
removed unnecessary test files
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 13, 2025
@jan-vcapgemini
devonfw#759: cleanup
488d5b9 
removed unnecessary test files
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 13, 2025
@jan-vcapgemini
devonfw#759: implemented requested changes
b4660a6 
fixed map eclipse legacy editions
added private modifier
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 13, 2025
@jan-vcapgemini
devonfw#759: implemented requested changes
b7b0d10 
cleanup
fixed typo
hohwille added a commit to leonrohne27/IDEasy that referenced this issue Jan 13, 2025
@hohwille
devonfw#759: review rework (JavaDoc)
3db4692
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 14, 2025
@jan-vcapgemini
devonfw#759: implemented requested changes
0ebdb62 
removed remove method from EnvironmentVariables
jan-vcapgemini added a commit to leonrohne27/IDEasy that referenced this issue Jan 14, 2025
@jan-vcapgemini
devonfw#759: implemented requested changes
115768c 
cleanup
hohwille pushed a commit that referenced this issue Jan 14, 2025
@leonrohne27
#759: upgrade settings commandlet (#820)
241ce06
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in IDEasy board Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hohwille hohwille

@jan-vcapgemini jan-vcapgemini

Labels
configuration should be configurable or configuration change enhancement New feature or request settings ide-settings repo and replated processes and features
Projects
IDEasy board
Status: ✅ Done
Milestone
release:2025.01.001
Development

Successfully merging a pull request may close this issue.

#759: upgrade settings commandlet leonrohne27/IDEasy
4 participants
@hohwille @jan-vcapgemini @KianRolf @leonrohne27