A workaround for 'ODO' stopped working after Devfile schema update to v.2.2.2 #4183 #4185

vrubezhny · 2024-06-06T21:53:06Z

This is the only workaround limiting the devfile version for node.js component to v.2.2.0 when running the integration tests

Issue: #4183

… v.2.2.2 redhat-developer#4183 This is the only workaround limiting the devfile version for node.js component to v.2.2.0 Issue: redhat-developer#4183 Signed-off-by: Victor Rubezhny <vrubezhny@redhat.com>

codecov-commenter · 2024-06-06T22:03:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.87%. Comparing base (da60441) to head (0460d6f).
Report is 276 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #4185       +/-   ##
===========================================
+ Coverage   32.37%   43.87%   +11.50%     
===========================================
  Files          85       95       +10     
  Lines        6505     7710     +1205     
  Branches     1349     1630      +281     
===========================================
+ Hits         2106     3383     +1277     
+ Misses       4399     4327       -72

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mohitsuman · 2024-06-07T03:59:54Z

src/odo/odoWrapper.ts

@@ -109,6 +109,7 @@ export class Odo {
        starter: string = undefined,
        useExistingDevfile = false,
        customDevfilePath = '',
+        devfileVersion?: string


how does it know which version of devfile it should not update to? we need to define it somewhere.

This is only a workaround to make the test working with current officially released 'odo' version and the Default Devfile Registry.

The officially released 'odo' supports devfile schema versions <= 2.2.0. So this version is provided as the value of this argument hereafter in the test when creating a component from 'node.js' devfile (because this devfile has multiple versions and [if not specifying this argument] odo returns the default one, which currently is set to be > 2.2.0.

We do not provide this argument value when creating a component with 'Go' devfile - its devfile returned by default has schema version < 2.2.0 so it perfectly works with odo.

mohitsuman

devfile version info ?

vrubezhny · 2024-06-07T12:58:23Z

devfile version info ?

NAME REGISTRY DESCRIPTION ARCHITECTURES VERSIONS
nodejs DefaultDevfileRegistry Node.js application 2.1.1, 2.2.0, 2.2.1

So, for these nodejs versions we're downloading devfiles with the following schema versions:

Stack Versions --> Schema Versions
nodejs 2.2.1 (latest) --> devfile 2.2.2
nodejs 2.1.1, 2.2.0 --> devfile 2.1.0

The PR makes odo to install Node.js version v.2.2.0 which makes it to download devfile with schema version 2.1.0 that odo is fully compatible with.

Default Devfile registry contains multiple versions for Node.js devfile, by default odo retrieves the devfile version marked as 'defaultwhich schema version is >2.2.0` - this make a problem for 'odo' that is officially released.

In order to fix tests we force 'odo' to retrieve a nodejs v.2.2.0 devfile with schema version === 2.1.0 instead of the default one, which makes 'odo' happy when it parses this schema.

There is a proposal to use nightly builds for 'odo' binary instead of official release (see: #4183 (comment)) - the devfile schema version issue is fixed on the main 'odo' branch and the fixed version is available at https://odo.dev/docs/overview/installation#nightly-builds

datho7561 · 2024-06-07T16:00:57Z

I still don't see the Nodejs devfile listed in the devfile registry viewer, so I don't think this will do much. (eg. you can't choose to create a project based on the nodejs devfile, so it doesn't make sense to reduce the version of that devfile that's used.)

vrubezhny · 2024-06-09T19:12:49Z

I still don't see the Nodejs devfile listed in the devfile registry viewer, so I don't think this will do much. (eg. you can't choose to create a project based on the nodejs devfile, so it doesn't make sense to reduce the version of that devfile that's used.)

This is a quite strange thing... as for the Default Devfile Registry:

Web site https://registry.devfile.io/viewer shows 32 entries
$ odo registry --devfile-registry DefaultDevfileRegistry | wc encounters 26 entries

... while the Devfile Registry editor shows only 11 entries.

Also, the result of odo registry --devfle-registry DefaultDevfileRegistry is a bit different from what we have on the web site, for instance the Web site contains devfile with name: wildfly while the command returns the same (or similar) defvile with name: java-wildfly... Looks like they actually reference the different registries or the output is modified somehow.

vrubezhny · 2024-06-10T01:06:52Z

We probably won't need this PR if we move to using ODO nightly builds.

See: PR #4191 - [build] Use ODO binary from nightly builds #4191

mohitsuman · 2024-06-10T01:19:17Z

@vrubezhny if there is a new release of odo binary, that should fix the issue?

vrubezhny · 2024-06-10T01:35:11Z

@vrubezhny if there is a new release of odo binary, that should fix the issue?

That's not a release (no more releases are produced unless they have a blocker issue), but nightly builds made from the ODO repository main branch that currently contains quite a lot of dependency updates. And the support for Devfile schema v.2.2.2 is included as well.
I've tested the current ODO nightly build: 3.15.0 (6d83e4043-nightly) - it creates a component from 'nodejs' devfile (schema v.2.2.2) with no problem:

$ odo version
odo v3.15.0 (6d83e4043-nightly)

Server: https://127.0.0.1:42801
Kubernetes: v1.27.3
Podman Client: 4.9.4

$ odo init --name=component1 --devfile=nodejs --starter=nodejs-starter
  __
 /  \__     Initializing a new component
 \__/  \    
 /  \__/    odo version: v3.15.0 (6d83e4043-nightly)
 \__/

 ✓  Downloading devfile "nodejs" [4s]
 ✓  Downloading starter project "nodejs-starter" [515ms]

Your new component 'component1' is ready in the current directory.
To start editing your component, use 'odo dev' and open this folder in your favorite IDE.
Changes will be directly reflected on the cluster.

$ cat devfile.yaml | grep schemaVersion:
schemaVersion: 2.2.2

So, yeah. Using ODO nightly builds should fix the issue.

vrubezhny · 2024-06-14T15:42:47Z

@vrubezhny if there is a new release of odo binary, that should fix the issue?

I probably got the question wrongly...

If ODO team makes a new release - then the problem will definitely be solved with no any changes from our side.

Using nightly builds looks now as a bed option, as the download URL is static and the track of nightly build binaries isn't kept - this really prevents us from using them.

datho7561

This fixes the integration test suite for the time being, which I think is very helpful.

@vrubezhny is this ready for merge?

vrubezhny · 2024-06-28T12:28:09Z

Closing this as not needed anymore after ODO v.3.16.1 is released and move to using ODO nightly builds for the following ODO updates

A workaround for 'ODO' stopped working after Devfile schema update to…

0460d6f

… v.2.2.2 redhat-developer#4183 This is the only workaround limiting the devfile version for node.js component to v.2.2.0 Issue: redhat-developer#4183 Signed-off-by: Victor Rubezhny <vrubezhny@redhat.com>

vrubezhny changed the title ~~A workaround for 'ODO' stopped working after Devfile schema update to…~~ A workaround for 'ODO' stopped working after Devfile schema update to v.2.2.2 #4183 Jun 7, 2024

vrubezhny requested a review from datho7561 June 7, 2024 00:15

vrubezhny mentioned this pull request Jun 7, 2024

'ODO' stopped working after Devfile schema update to v.2.2.2 #4183

Closed

mohitsuman reviewed Jun 7, 2024

View reviewed changes

vrubezhny self-assigned this Jun 7, 2024

vrubezhny mentioned this pull request Jun 8, 2024

[build] Use ODO binary from nightly builds #4191

Merged

vrubezhny marked this pull request as draft June 10, 2024 01:00

openshift-ci bot added the do-not-merge/work-in-progress label Jun 10, 2024

datho7561 approved these changes Jun 14, 2024

View reviewed changes

vrubezhny closed this Jun 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A workaround for 'ODO' stopped working after Devfile schema update to v.2.2.2 #4183 #4185

A workaround for 'ODO' stopped working after Devfile schema update to v.2.2.2 #4183 #4185

vrubezhny commented Jun 6, 2024 •

edited

Loading

codecov-commenter commented Jun 6, 2024 •

edited

Loading

mohitsuman Jun 7, 2024

vrubezhny Jun 7, 2024 •

edited

Loading

mohitsuman left a comment

vrubezhny commented Jun 7, 2024 •

edited

Loading

datho7561 commented Jun 7, 2024

vrubezhny commented Jun 9, 2024

vrubezhny commented Jun 10, 2024

mohitsuman commented Jun 10, 2024

vrubezhny commented Jun 10, 2024 •

edited

Loading

vrubezhny commented Jun 14, 2024 •

edited

Loading

datho7561 left a comment

vrubezhny commented Jun 28, 2024

A workaround for 'ODO' stopped working after Devfile schema update to v.2.2.2 #4183 #4185

A workaround for 'ODO' stopped working after Devfile schema update to v.2.2.2 #4183 #4185

Conversation

vrubezhny commented Jun 6, 2024 • edited Loading

codecov-commenter commented Jun 6, 2024 • edited Loading

Codecov Report

mohitsuman Jun 7, 2024

Choose a reason for hiding this comment

vrubezhny Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

mohitsuman left a comment

Choose a reason for hiding this comment

vrubezhny commented Jun 7, 2024 • edited Loading

datho7561 commented Jun 7, 2024

vrubezhny commented Jun 9, 2024

vrubezhny commented Jun 10, 2024

mohitsuman commented Jun 10, 2024

vrubezhny commented Jun 10, 2024 • edited Loading

vrubezhny commented Jun 14, 2024 • edited Loading

datho7561 left a comment

Choose a reason for hiding this comment

vrubezhny commented Jun 28, 2024

vrubezhny commented Jun 6, 2024 •

edited

Loading

codecov-commenter commented Jun 6, 2024 •

edited

Loading

vrubezhny Jun 7, 2024 •

edited

Loading

vrubezhny commented Jun 7, 2024 •

edited

Loading

vrubezhny commented Jun 10, 2024 •

edited

Loading

vrubezhny commented Jun 14, 2024 •

edited

Loading