Feature: Added Keploy Update to CLI

[Akash-Singh04]

Related Issue

• This pull request enhances the update functionality in the Keploy CLI tool to ensure smoother and more efficient updates of the Keploy binary file.

Resolves: #1303

Describe the changes you've made

The updates include:

Addition of Update Command

• Integrated the update command in the Keploy CLI to fetch the latest version from the GitHub repository.
• Refactored the update process to verify the current installed version against the latest available version fetched from the repository.
• Integrated GitHub API requests to retrieve the latest release version and get the changelog
• Updated the binary file
• Display the changelog after the version has been successfully updated

Addition of notification for new update

• Checks for a new update whenever keploy CLI is used
• If a new update is available, prompts the user in a non invasive way to update the binary file.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Code style update (formatting, local variables)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Please let us know if any test cases are added

NIL

Describe if there is any unusual behaviour of your code(Write NA if there isn't)

NA

A clear and concise description of it.

Checklist:

• My code follows the style guidelines of this project.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• I have added tests that prove my fix is effective or that my feature works.
• New and existing unit tests pass locally with my changes.

Screenshots (if any)

[github-actions]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[Akash-Singh04]

I have read the CLA Document and I hereby sign the CLA

[AkashKumar7902]

@Akash-Singh04 If there is a way to get the changelog for the new version, it would be great to display it after updating the binary.

[AkashKumar7902]

Also, if the api endpoint used to fetch the version is down or unresponsive, will the keploy execution hang waiting for a response from the endpoint ?
if it hangs, then set an appropriate timeout. show an error of unresponsiveness only during keploy update execution, the other commands should run fine.
After completion please update the PR description.

[AkashKumar7902]

you can transfer the redundant getlatestreleaseversion function to utils/utils.go

[AkashKumar7902]

please address the review comments

[AkashKumar7902]

Highlight the keploy update command in gray in the version available msg. also just run 'keploy update' to update would be good. remove the quotes around keploy update too.

It should look like:

Decrease the length of the box by 20-30%

[Akash-Singh04]

Understood! Working on the proposed changes!

[Akash-Singh04]

you can transfer the redundant getlatestreleaseversion function to utils/utils.go

since the utils/utils.go package is on https://pkg.go.dev/go.keploy.io/server/utils , i am unable to modify that package into having the getGithubUpdateRelease() function. Am i missing out on something here?

If so kindly let me know how do i update the utils package to now include this new function

[Akash-Singh04]

@AkashKumar7902 Updated the PR, kindly have a look and revert

[AkashKumar7902]

when I ran keploy after update command then, I get this :

investigate why this is happening as my binary is up to date.

[AkashKumar7902]

the changelog returned by the github api is in the form of markdown. we can't display raw markdown. convert into a pretty format

[Akash-Singh04]

Will make the necessary changes and revert

[Akash-Singh04]

when I ran keploy after update command then, I get this : investigate why this is happening as my binary is up to date.

The reason for this behaviour is that when we are using a development version, the version of the binary file is automatically set to "2-dev".

As using the command

sudo go run main.go

You are creating a new development version of the binary file and executing it, the version doesn't match the latest release version.

That is my hyothesis for the cause of this behaviour. Please feel free to correct me or suggest an alternative approach.

[Akash-Singh04]

@charankamarapu @AkashKumar7902 How are we planning to implement the update message? As @charankamarapu pointed out, it will cause a 2-3s delay everytime a keploy command is run as it is making an HTTP request.

An alternative i can suggest is to instead have the message pop up at the end of command execution, hence not effecting the user experience.

Kindly let me know the implementation of this, alternatively we can seggregate the update message into a different issue to reflect upon it further

[charankamarapu]

Please address the comments

[charankamarapu]

Please address the comments

[charankamarapu]

Please address the comment everything else looks good to me.

[charankamarapu]

Ship it!