add --update option #693

NicolasKeita · 2023-10-16T11:52:53Z

add --update option (or -u) to enable comparing the user's version of each framework to the latest version available.

Inspired by an old issue #74 and I wanted to help.

Side nodes:

This new feature does not fully automate the update of all outdated packages (it proposes to the user to only update one package) but presents a clear indication of which frameworks are outdated (there are rooms for improvements).
I did not create test-cases for this feature but I didn't break any previous successful tests neither. (There are rooms for improvements).

Feature details:

I get the framework's latest version from parsing the package url.
I get the current user version of the framework by reading files in the install_path (most of the times, there is a version.txt file. I handle it differently for each framework).
Then I compare and display which framework is outdated in the terminal as shown in the image below.

LyzardKing · 2023-10-27T09:27:15Z

Hi. Thanks for contributing this.
The update functionality has been on my mind for a while.
Unfortunately I don't have too much time to check this, but I'll get to it soon.

Just a first few suggestions:

I would avoid printing everything, and instead only show the updatable items.
keep the default "Missing Information" functions in baseInstaller, and just override if needed.

In a previous attempt I started a while back I added an argument (updatable) to distinguish the frameworks that shouldn't be updatet through umake (e.g. those that have their own updater).

LyzardKing · 2023-10-27T09:37:00Z

You can find the old version of the update function here:
#506

Just to have a quick look at the defaults and "updatable" argument.

LyzardKing · 2024-01-06T19:38:53Z

Hi @NicolasKeita
I haven't had much time to look into this, but I'm updating a few things (packaging mainly) on the new_snap branch.
I need to simplify/remove most of the tests, since they are not maintained.

Did you manage to look at making the update function more modular?

NicolasKeita · 2024-01-06T23:34:12Z

Hi,

I believe that I approached the task with the mindset of adding my code on top of the existing code rather than modifying it to avoid any potential disruptions.
If the tests could be revised, I would be more confident in improving my pull request.
I believe I can make it more modular :)

LyzardKing · 2024-01-07T11:33:16Z

Thank you very much for the patience and willingness to look into this.

My proposal would be to split this in two:

add a generic "default" method in frameworks/init.py and frameworks/baseInstaller.py (as in the previous attempt I linked to)
override that method only in frameworks that can update via umake (things like intellij should not because they have their own update system)
add a --list-upgradable in init.py that shows what you did now, so a list of upgradable frameworks.. I would not format them as a table, or anything fancy, trying instead to reuse most of the list method that exists now.

Let me know what you think, and thank you again!

NicolasKeita · 2024-01-08T04:56:09Z

Thanks.

I understood the proposal. Looks good to me. I'll take your pull request (#506) code as base. I should be submitting something in the next few days.

LyzardKing · 2024-01-08T09:49:16Z

Keep in mind that my old pull request is very old now, so it's not up to date. Just look at it for pointers, or rebase that on master. The first one might be easier.

Let me know if you need help with anything!

The changes I'll be making should not interfere with whatever you do, and at the moment they live in different branches.

LyzardKing

I gave your code another look,
I think it's great, and the only thing required is to avoid repeating too much code in the single frameworks.

If possible keep the default methods (those that say missing information) in baseinstaller, and the frameworks only override them if they are updatable by umake.

LyzardKing · 2024-01-08T09:53:58Z

umake/frameworks/crystal.py

@@ -75,3 +75,10 @@ def post_install(self):
        """Add Crystal necessary env variables"""
        add_env_to_user(self.name, {"PATH": {"value": os.path.join(self.install_path, "bin")}})
        UI.delayed_display(DisplayMessage(self.RELOGIN_REQUIRE_MSG.format(self.name)))
+
+    def parse_latest_version_from_package_url(self):


Initially you can remove these empty methods, and add them to baseinstaller/init
so the single frameworks only override this if they can

LyzardKing · 2024-01-08T09:55:56Z

umake/frameworks/dart.py

@@ -79,6 +79,18 @@ def post_install(self):
        add_env_to_user(self.name, {"PATH": {"value": os.path.join(self.install_path, "bin")}})
        UI.delayed_display(DisplayMessage(self.RELOGIN_REQUIRE_MSG.format(self.name)))

+    def parse_latest_version_from_package_url(self):


These are fine, since they add what is specific to a package, although they could simply return the regex string, and let a method in baseinstaller deal with evaluating the regex

LyzardKing · 2024-01-08T09:59:05Z

umake/ui/cli/__init__.py

@@ -243,9 +300,52 @@ def main(parser):
        print(get_version())
        sys.exit(0)

+    if args.update:


keep this as is, we can evantually replace the prettyprint, but it looks good for now

NicolasKeita · 2024-01-10T04:39:22Z

umake/frameworks/__init__.py

+    @staticmethod
+    def get_current_user_version(install_path):
+        return None
+


Adding two default methods for each framework.
get_latest_version() is getting the version from parsing the download_url.
get_current_user_version() is overridden in each of the framework. It is checking the installed files (like VERSION.txt for example) to fetch the version.

NicolasKeita · 2024-01-10T04:51:22Z

the pretty_print function can be easily remove if needed. I filtered only the outdated frameworks (compared to printing every framework installed)

NicolasKeita · 2024-01-10T04:58:52Z

umake/frameworks/__init__.py

@@ -153,6 +154,8 @@ def __init__(self, name, description, category, force_loading=False, logo_path=N
        self.packages_requirements.extend(self.category.packages_requirements)
        self.only_for_removal = only_for_removal
        self.expect_license = expect_license
+        self.version_regex = version_regex
+        self.forbidden_to_update = False


self.forbidden_to_update = False

This was my way of preventing an update on some frameworks like Intellij.
Set by default at False then overridden in the class BaseJetBrains for example.

I would have used it the other way around, keeping the default as not updatable, and setting a framework to updatable explicitly. This way we only add information for those that have this functionality.

What do you think?

After thinking about it, I 100% agree with you. I have committed these changes 👍

NicolasKeita · 2024-01-10T05:16:02Z

umake/ui/cli/__init__.py

+            for outdated_framework in outdated_frameworks:
+                if outdated_framework['forbidden_to_update'] is False:
+                    args = parser.parse_args([outdated_framework['category_name'], outdated_framework['framework_name']])
+                    CliUI()
+                    run_command_for_args(args)
+                    return


If multiple outdated frameworks are present, only the first framework updates (the return statement is early).
I struggled a bit with running CliUI() in a loop.

PS: sorry about the useless/extra commit (Merge branch 'ubuntu:master' into master)

I'll look into this.
The best way would probably be to relaunch umake, but I'll let you know

Set specific frameworks to be updatable and make non-updatable the default for all other frameworks

LyzardKing · 2024-01-11T09:21:20Z

Great!

The only thing missing now is to add a couple of tests. Do you think you could look into that? Specifically a "small" test (you can find them in the tests/small folder), to see if the behaviour is consistent.

I've been looking into the multiple update, and I think I have an idea, but I need to test it out. Basically we should have a way to run umake with multiple frameworks first (for the install as well), then we could reuse that for the update.

NicolasKeita · 2024-01-11T11:48:42Z

Yes, working on it 👍

NicolasKeita · 2024-01-15T09:44:35Z

Hi,

I couldn't add proper tests.
I've faced difficulties with simple tasks, such as initializing a framework object or installing a framework.
I've added a placeholder for tests in the meantime. I don't think I am able to perform the tests 😞

LyzardKing · 2024-01-18T11:55:56Z

I'll look at adding a few tests, just to check that future updates don't break everything, then I'll merge.
I might need some time though, since work is taking over at the moment.
I'll keep you posted and hopefully this can be merged soon.

Thanks again!

LyzardKing · 2024-02-26T12:31:32Z

Merging in a separate branch to check and add tests if possible.
It'll be then merged in master

add --update option

9d78926

LyzardKing reviewed Jan 8, 2024

View reviewed changes

NicolasKeita added 2 commits January 10, 2024 05:02

Merge branch 'ubuntu:master' into master

b412e55

remove duplicate code in each frameworks about '-update'

e7b3d36

NicolasKeita commented Jan 10, 2024

View reviewed changes

Refactor: Explicitly set updateability for certain frameworks

3b77df8

Set specific frameworks to be updatable and make non-updatable the default for all other frameworks

Add placeholder for tests about --update

ee53ec8

LyzardKing changed the base branch from master to update February 26, 2024 12:28

LyzardKing merged commit 3f67a87 into ubuntu:update Feb 26, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add --update option #693

add --update option #693

NicolasKeita commented Oct 16, 2023 •

edited

Loading

LyzardKing commented Oct 27, 2023 •

edited

Loading

LyzardKing commented Oct 27, 2023

LyzardKing commented Jan 6, 2024

NicolasKeita commented Jan 6, 2024

LyzardKing commented Jan 7, 2024

NicolasKeita commented Jan 8, 2024

LyzardKing commented Jan 8, 2024

LyzardKing left a comment

LyzardKing Jan 8, 2024

LyzardKing Jan 8, 2024

LyzardKing Jan 8, 2024

NicolasKeita Jan 10, 2024 •

edited

Loading

NicolasKeita commented Jan 10, 2024

NicolasKeita Jan 10, 2024 •

edited

Loading

LyzardKing Jan 10, 2024

NicolasKeita Jan 10, 2024

NicolasKeita Jan 10, 2024 •

edited

Loading

LyzardKing Jan 10, 2024

LyzardKing commented Jan 11, 2024

NicolasKeita commented Jan 11, 2024

NicolasKeita commented Jan 15, 2024

LyzardKing commented Jan 18, 2024

LyzardKing commented Feb 26, 2024

add --update option #693

add --update option #693

Conversation

NicolasKeita commented Oct 16, 2023 • edited Loading

LyzardKing commented Oct 27, 2023 • edited Loading

LyzardKing commented Oct 27, 2023

LyzardKing commented Jan 6, 2024

NicolasKeita commented Jan 6, 2024

LyzardKing commented Jan 7, 2024

NicolasKeita commented Jan 8, 2024

LyzardKing commented Jan 8, 2024

LyzardKing left a comment

Choose a reason for hiding this comment

LyzardKing Jan 8, 2024

Choose a reason for hiding this comment

LyzardKing Jan 8, 2024

Choose a reason for hiding this comment

LyzardKing Jan 8, 2024

Choose a reason for hiding this comment

NicolasKeita Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

NicolasKeita commented Jan 10, 2024

NicolasKeita Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

LyzardKing Jan 10, 2024

Choose a reason for hiding this comment

NicolasKeita Jan 10, 2024

Choose a reason for hiding this comment

NicolasKeita Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

LyzardKing Jan 10, 2024

Choose a reason for hiding this comment

LyzardKing commented Jan 11, 2024

NicolasKeita commented Jan 11, 2024

NicolasKeita commented Jan 15, 2024

LyzardKing commented Jan 18, 2024

LyzardKing commented Feb 26, 2024

NicolasKeita commented Oct 16, 2023 •

edited

Loading

LyzardKing commented Oct 27, 2023 •

edited

Loading

NicolasKeita Jan 10, 2024 •

edited

Loading

NicolasKeita Jan 10, 2024 •

edited

Loading

NicolasKeita Jan 10, 2024 •

edited

Loading