fix: apply .bashrc when running a task #395

vitaliy-guliy · 2024-08-05T13:19:28Z

What does this PR do?

This is alternative to #383

What issues does this PR fix?

eclipse-che/che#23009

How to test this PR?

create a workspace using following
repository https://github.com/vitaliy-guliy/vscode-test-extension/tree/test-sh-terminal
editor quay.io/che-incubator-pull-requests/che-code:pr-395-amd64
launch test tasks to check the variables for tools and mongo containers
check PATH environment variable

The variable seems to be different because of different .bashrs files in both containers.

Does this PR contain changes that override default upstream Code-OSS behavior?

the PR contains changes in the code folder (you can skip it if your changes are placed in a che extension )
the corresponding items were added to the CHANGELOG.md file
rules for automatic git rebase were added to the .rebase folder

Signed-off-by: vitaliy-guliy <[email protected]>

github-actions · 2024-08-05T13:19:40Z

Click here to review and test in web IDE:

github-actions · 2024-08-05T18:38:51Z

Pull Request images published ✨

Editor: quay.io/che-incubator-pull-requests/che-code:pr-395-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-395-dev-amd64

vitaliy-guliy · 2024-08-06T14:06:44Z

@AObuchow wdyt?

azatsarynnyy

👍

AObuchow · 2024-08-06T14:57:02Z

code/extensions/che-terminal/src/machine-exec-client.ts

@@ -136,6 +138,11 @@ export class MachineExecClient implements vscode.Disposable {
 	 * @returns a TerminalSession object to manage the created terminal session
 	 */
 	async createTerminalSession(component: string, commandLine?: string, workdir?: string, columns: number = 80, rows: number = 24): Promise<TerminalSession> {
+		if (commandLine) {
+			const bashrc = join(env.HOME!, '.bashrc');
+			commandLine = `test -f ${bashrc} >> /dev/null 2>&1 && source ${bashrc};${commandLine}`;


It's worth creating a .bashrc that will cause an error (e.g. add cat nonExistentFile.txt) to see if that breaks running Devfile tasks with this approach. In theory, it shouldn't since we are using ; instead of &&. However, I suspect any errors in calling source ~/.bashrc will be logged when running the Devfile task. I'm not sure if that is desired?

A potential advantage of #383 is that we only call source ~/.bashrc once, and catch the error.

In the current approach, if the call to source ~/.bashrc results in any errors, the errors will repeatedly be hit when running a devfile task.

I like the idea to experiment with .bashrc. Let me then update the repository I'm using to test the pull request.

However, I suspect any errors in calling source ~/.bashrc will be logged when running the Devfile task. I'm not sure if that is desired?

Good catch. I will experiment with this as well.

vitaliy-guliy · 2024-08-06T16:20:43Z

I found another mistaking.
HOME in mongo container is configured to /var/lib/mongodb. But the path to .bashrc file was taken based on the HOME taken from the tools container.

const bashrc = join(env.HOME!, '.bashrc');

As result .bashrc from mounted /home/user directory will be used as a source.
This is not right.
It needs to get HOME value from mongo container and try to find .bashrc based on the given value.

AObuchow · 2024-08-06T19:14:20Z

I found another mistaking. HOME in mongo container is configured to /var/lib/mongodb. But the path to .bashrc file was taken based on the HOME taken from the tools container.
const bashrc = join(env.HOME!, '.bashrc');
As result .bashrc from mounted /home/user directory will be used as a source. This is not right. It needs to get HOME value from mongo container and try to find .bashrc based on the given value.

Isin't that the intended behaviour for resolving eclipse-che/che#23009 however? I thought we wanted the same $PATH in other containers that the tooling has?

vitaliy-guliy · 2024-08-06T20:17:10Z

Isin't that the intended behaviour for resolving eclipse-che/che#23009 however? I thought we wanted the same $PATH in other containers that the tooling has?

If the container has its own .bashrc, lets use it.
And it does not prevent us from resolving eclipse-che/che#23009

Signed-off-by: vitaliy-guliy <[email protected]>

github-actions · 2024-08-07T10:12:57Z

Pull Request images published ✨

Editor: quay.io/che-incubator-pull-requests/che-code:pr-395-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-395-dev-amd64

vitaliy-guliy · 2024-08-07T13:53:34Z

There is no .bashrc file in the home directory in mongo container.

To test the behavior I created a .bashrc file in project directory and added a test variable.
Then I opened a terminal in mongo container and copied the .bashrc to HOME directory with

$ cp /projects/vscode-test-extension/.bashrc ${HOME}/

and then checked for the file

$ ls -la ${HOME}
total 12
drwxrwxr-x. 1 mongodb    root         50 Aug  7 13:47 .
drwxr-xr-x. 1 root       root         21 Sep 17  2020 ..
-rw-r--r--. 1 1000300000 root         31 Aug  7 13:47 .bashrc
-rw-------. 1 1000300000 root        111 Aug  7 13:33 .dbshell
drwxr-xr-x. 2 1000300000 root         20 Aug  7 13:33 .kube
drwxrwsr-x. 4 root       1000300000 4096 Aug  7 13:39 data

After that I launched Run test script - mongo task and checked the corresponding .bashrc is applied

AObuchow

LGTM 👍

devstudio-release · 2024-08-08T12:06:03Z

Build 3.17 :: code_3.x/1450: Console, Changes, Git Data

devstudio-release · 2024-08-08T12:06:04Z

Build 3.16 :: code_3.16/1: Console, Changes, Git Data

devstudio-release · 2024-08-08T12:14:38Z

Build 3.16 :: sync-to-downstream_3.16/6: Console, Changes, Git Data

devstudio-release · 2024-08-08T12:17:43Z

Build 3.17 :: sync-to-downstream_3.x/7396: Console, Changes, Git Data

devstudio-release · 2024-08-08T12:23:40Z

Build 3.16 :: get-sources-rhpkg-container-build_3.16/6: Console, Changes, Git Data

devstudio-release · 2024-08-08T12:28:50Z

Build 3.17 :: get-sources-rhpkg-container-build_3.x/7378: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:12:39Z

Build 3.16 :: push-latest-container-to-quay_3.16/10: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:14:52Z

Build 3.16 :: get-sources-rhpkg-container-build_3.16/6:

code : 3.16 :: Build 63210162 : quay.io/devspaces/code-rhel8:3.16-16
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.16/10 triggered

devstudio-release · 2024-08-08T17:14:52Z

Build 3.16 :: update-digests_3.16/10: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:14:56Z

Build 3.16 :: code_3.16/1:

Upstream sync done; /DS_CI/sync-to-downstream_3.16/6 triggered

devstudio-release · 2024-08-08T17:15:28Z

Build 3.16 :: operator-bundle_3.16/5: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:18:36Z

Build 3.16 :: sync-to-downstream_3.16/11: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:19:06Z

Build 3.16 :: get-sources-rhpkg-container-build_3.16/11: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:37:09Z

Build 3.17 :: push-latest-container-to-quay_3.x/4860: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:42:40Z

Build 3.17 :: get-sources-rhpkg-container-build_3.x/7378:

code : 3.x :: Build 63210209 : quay.io/devspaces/code-rhel8:3.17-1
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/4860 triggered

devstudio-release · 2024-08-08T17:42:44Z

Build 3.17 :: code_3.x/1450:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/7396 triggered

devstudio-release · 2024-08-08T17:42:48Z

Build 3.17 :: update-digests_3.x/7270: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:48:30Z

Build 3.17 :: operator-bundle_3.x/3399: Console, Changes, Git Data

devstudio-release · 2024-08-08T17:55:06Z

Build 3.17 :: sync-to-downstream_3.x/7402: Console, Changes, Git Data

devstudio-release · 2024-08-08T18:00:00Z

Build 3.17 :: get-sources-rhpkg-container-build_3.x/7384: Console, Changes, Git Data

devstudio-release · 2024-08-08T18:29:09Z

Build 3.16 :: push-latest-container-to-quay_3.16/11: Console, Changes, Git Data

devstudio-release · 2024-08-08T18:30:54Z

Build 3.17 :: get-sources-rhpkg-container-build_3.x/7384:

devspaces-operator-bundle : 3.x :: Failed in 63219318 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

devstudio-release · 2024-08-08T18:31:44Z

Build 3.16 :: copyIIBsToQuay/2748: Console, Changes, Git Data

devstudio-release · 2024-08-08T18:32:22Z

Build 3.16 :: get-sources-rhpkg-container-build_3.16/11:

devspaces-operator-bundle : 3.16 :: Build 63218265 : quay.io/devspaces/devspaces-operator-bundle:3.16-43
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.16/11 triggered;
Bundle CSV related images:
- quay.io/devspaces/code-rhel8:3.16-16
- quay.io/devspaces/configbump-rhel8:3.16-2
- quay.io/devspaces/dashboard-rhel8:3.16-18
- quay.io/devspaces/devfileregistry-rhel8:3.16-61
- quay.io/devspaces/devspaces-rhel8-operator:3.16-7
- quay.io/devspaces/idea-rhel8:3.16-7
- quay.io/devspaces/pluginregistry-rhel8:3.16-10
- quay.io/devspaces/server-rhel8:3.16-12
- quay.io/devspaces/traefik-rhel8:3.16-1
- quay.io/devspaces/udi-rhel8:3.16-4
= registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.12.0-202407151105.p0.gb17014f.assembly.stream.el8
= registry.redhat.io/openshift4/ose-oauth-proxy:v4.12.0-202407151105.p0.g03e5b13.assembly.stream.el8
= registry.redhat.io/rhscl/mongodb-36-rhel7:1-50
= registry.redhat.io/ubi8/ubi-minimal:8.8-1072.1697626218

devstudio-release · 2024-08-08T18:32:25Z

Build 3.16 :: sync-to-downstream_3.16/11:

Build container: devspaces-operator-bundle synced; /DS_CI/get-sources-rhpkg-container-build_3.16/11 triggered; /job/DS_CI/job/dsc_3.16 triggered;

devstudio-release · 2024-08-08T18:32:26Z

Build 3.16 :: operator-bundle_3.16/5:

Upstream sync done; /DS_CI/sync-to-downstream_3.16/11 triggered

devstudio-release · 2024-08-08T18:33:53Z

Build 3.16 :: dsc_3.16/6: Console, Changes, Git Data

devstudio-release · 2024-08-08T18:33:58Z

Build 3.16 :: update-digests_3.16/10:

Detected new images: rebuild operator-bundle
* code; /DS_CI/operator-bundle_3.16/5 triggered

devstudio-release · 2024-08-08T18:40:51Z

Build 3.16 :: dsc_3.16/6:

3.16.0-CI

devstudio-release · 2024-08-08T19:36:20Z

Build 3.16 :: copyIIBsToQuay/2748:

3.16
arches = x86_64, s390x, ppc64le;
  * LATEST DS OPERATOR BUNDLE = <a href=https://quay.io/repository/devspaces/devspaces-operator-bundle?tab=tags>registry-proxy.engineering.redhat.com/rh-osbs/devspaces-operator-bundle:3.16-43
  * LATEST DWO OPERATOR BUNDLE = <a href=https://quay.io/repository/devworkspace/devworkspace-operator-bundle?tab=tags>registry-proxy.engineering.redhat.com/rh-osbs/devworkspace-operator-bundle:???
+ s390x-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.16-v4.16-785039-s390x
  + quay.io/devspaces/iib:3.16-v4.16-s390x
  + quay.io/devspaces/iib:latest-v4.16-s390x
  + quay.io/devspaces/iib:3.16-v4.15-785221-s390x
  + quay.io/devspaces/iib:3.16-v4.15-s390x
  + quay.io/devspaces/iib:latest-v4.15-s390x
  + quay.io/devspaces/iib:3.16-v4.14-785220-s390x
  + quay.io/devspaces/iib:3.16-v4.14-s390x
  + quay.io/devspaces/iib:latest-v4.14-s390x
  + quay.io/devspaces/iib:3.16-v4.13-785219-s390x
  + quay.io/devspaces/iib:3.16-v4.13-s390x
  + quay.io/devspaces/iib:latest-v4.13-s390x
  + quay.io/devspaces/iib:3.16-v4.12-785224-s390x
  + quay.io/devspaces/iib:3.16-v4.12-s390x
  + quay.io/devspaces/iib:latest-v4.12-s390x
+ x86_64-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.16-v4.16-785039-x86_64
  + quay.io/devspaces/iib:3.16-v4.16-x86_64
  + quay.io/devspaces/iib:latest-v4.16-x86_64
  + quay.io/devspaces/iib:3.16-v4.15-785221-x86_64
  + quay.io/devspaces/iib:3.16-v4.15-x86_64
  + quay.io/devspaces/iib:latest-v4.15-x86_64
  + quay.io/devspaces/iib:3.16-v4.14-785220-x86_64
  + quay.io/devspaces/iib:3.16-v4.14-x86_64
  + quay.io/devspaces/iib:latest-v4.14-x86_64
  + quay.io/devspaces/iib:3.16-v4.13-785219-x86_64
  + quay.io/devspaces/iib:3.16-v4.13-x86_64
  + quay.io/devspaces/iib:latest-v4.13-x86_64
  + quay.io/devspaces/iib:3.16-v4.12-785224-x86_64
  + quay.io/devspaces/iib:3.16-v4.12-x86_64
  + quay.io/devspaces/iib:latest-v4.12-x86_64
+ ppc64le-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.16-v4.16-785039-ppc64le
  + quay.io/devspaces/iib:3.16-v4.16-ppc64le
  + quay.io/devspaces/iib:latest-v4.16-ppc64le
  + quay.io/devspaces/iib:3.16-v4.15-785221-ppc64le
  + quay.io/devspaces/iib:3.16-v4.15-ppc64le
  + quay.io/devspaces/iib:latest-v4.15-ppc64le
  + quay.io/devspaces/iib:3.16-v4.14-785220-ppc64le
  + quay.io/devspaces/iib:3.16-v4.14-ppc64le
  + quay.io/devspaces/iib:latest-v4.14-ppc64le
  + quay.io/devspaces/iib:3.16-v4.13-785219-ppc64le
  + quay.io/devspaces/iib:3.16-v4.13-ppc64le
  + quay.io/devspaces/iib:latest-v4.13-ppc64le
  + quay.io/devspaces/iib:3.16-v4.12-785224-ppc64le
  + quay.io/devspaces/iib:3.16-v4.12-ppc64le
  + quay.io/devspaces/iib:latest-v4.12-ppc64le

fix: apply .bashrc when running a task

937df89

Signed-off-by: vitaliy-guliy <[email protected]>

vitaliy-guliy marked this pull request as ready for review August 6, 2024 10:01

vitaliy-guliy requested review from azatsarynnyy and RomanNikitenko as code owners August 6, 2024 10:01

RomanNikitenko approved these changes Aug 6, 2024

View reviewed changes

azatsarynnyy approved these changes Aug 6, 2024

View reviewed changes

AObuchow reviewed Aug 6, 2024

View reviewed changes

update

d55cc1b

Signed-off-by: vitaliy-guliy <[email protected]>

vitaliy-guliy marked this pull request as draft August 6, 2024 20:25

update

2e1d640

Signed-off-by: vitaliy-guliy <[email protected]>

vitaliy-guliy marked this pull request as ready for review August 7, 2024 13:53

vitaliy-guliy mentioned this pull request Aug 7, 2024

fix: use ~/.bashrc in sh shell #383

Closed

3 tasks

AObuchow approved these changes Aug 7, 2024

View reviewed changes

ibuziuk approved these changes Aug 8, 2024

View reviewed changes

vitaliy-guliy merged commit dd29c50 into main Aug 8, 2024
7 checks passed

vitaliy-guliy deleted the bash-as-a-source-2 branch August 8, 2024 12:04

vitaliy-guliy added the made-with-che Changes made with Che-Code label Sep 24, 2024

fix: apply .bashrc when running a task #395

fix: apply .bashrc when running a task #395

Conversation

vitaliy-guliy commented Aug 5, 2024 • edited Loading

What does this PR do?

What issues does this PR fix?

How to test this PR?

Does this PR contain changes that override default upstream Code-OSS behavior?

github-actions bot commented Aug 5, 2024 • edited Loading

github-actions bot commented Aug 5, 2024

vitaliy-guliy commented Aug 6, 2024

azatsarynnyy left a comment

Choose a reason for hiding this comment

AObuchow Aug 6, 2024

Choose a reason for hiding this comment

vitaliy-guliy Aug 6, 2024

Choose a reason for hiding this comment

vitaliy-guliy commented Aug 6, 2024

AObuchow commented Aug 6, 2024

vitaliy-guliy commented Aug 6, 2024

github-actions bot commented Aug 7, 2024

vitaliy-guliy commented Aug 7, 2024

AObuchow left a comment

Choose a reason for hiding this comment

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

devstudio-release commented Aug 8, 2024

vitaliy-guliy commented Aug 5, 2024 •

edited

Loading

github-actions bot commented Aug 5, 2024 •

edited

Loading