Bug #20757: arvados-client binary doesn't seem to sometimes pick up ~/.config/arvados/settings.conf - Arvados

Actions

Copy link

Bug #20757

closed

arvados-client binary doesn't seem to sometimes pick up ~/.config/arvados/settings.conf

Added by Lucas Di Pentima over 1 year ago. Updated about 1 year ago.

Status:

Resolved

Priority:

Normal

Assigned To:

Tom Clegg

Category:

SDKs

Target version:

Development 2023-08-30

Story points:

Release:

Arvados 2.7.0

Release relationship:

Auto

Description

While using a shell node:

shell login: lucasdipentima2
Password: (sent authentication token)

lucasdipentima2@shell:~$ arvados-client user current
{
 "can_manage":true,
 "can_write":true,
 "created_at":"2022-02-18T19:38:28.442053000Z",
...                         
 "username":"lucasdipentima2",
 "uuid":"jutro-tpzed-parp8dft47kpewf",
 "writable_by":[
  "pirca-tpzed-000000000000000",
  "jutro-tpzed-parp8dft47kpewf",
  "pirca-j7d0g-000000000000000" 
 ]
}
lucasdipentima2@shell:~$ arvados-client shell pirca-xvhdp-bmb06zf8s87ekso
fatal: ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are not set

OTOH, arvados-client diagnostics works fine, so maybe there're just some code paths that aren't using the credentials from settings.conf.

Subtasks 1 (0 open — 1 closed)

Actions

Copy link

Updated by Lucas Di Pentima over 1 year ago

Description updated (diff)
Subject changed from arvados-client binary doesn't seem to sometimes pick up ~/.config/arvados/settings.ini to arvados-client binary doesn't seem to sometimes pick up ~/.config/arvados/settings.conf

Actions

Copy link

Updated by Tom Clegg over 1 year ago

Aha. The shell command loads directly from env vars. It should use NewClientFromEnv instead, like the logs command in the same file (source:cmd/arvados-client/container_gateway.go), which also knows how to read settings.conf.

Actions

Copy link

Updated by Peter Amstutz over 1 year ago

Target version changed from Future to Development 2023-08-30

Actions

Copy link

Updated by Peter Amstutz over 1 year ago

Assigned To set to Tom Clegg
Subject changed from arvados-client binary doesn't seem to sometimes pick up ~/.config/arvados/settings.conf to arvados-client binary doesn't seem to sometimes pick up ~/.config/arvados/settings.conf

Actions

Copy link

Updated by Tom Clegg about 1 year ago

20757-ctr-shell-settings @ 70f0fb817d242a804a9e1647b526348742416b52 -- developer-run-tests: #3796

The testing code changed a bit (using go install . instead of go run .) because go run . is awfully slow when you run it with a new temporary $HOME dir for the purpose of controlling $HOME/.config/arvados/settings.conf.

Actions

Copy link

Updated by Tom Clegg about 1 year ago

Status changed from New to In Progress

Actions

Copy link

Updated by Brett Smith about 1 year ago

Tom Clegg wrote in #note-5:

20757-ctr-shell-settings @ 70f0fb817d242a804a9e1647b526348742416b52 -- developer-run-tests: #3796

This is good to merge, my two low-priority cents:

In my opinion, reusing the two arvados-client shell invocations in TestShellGateway to test the two different connection methods dilutes the value of the test, because now you potentially have to do more work to diagnose a test failure: did it fail because it didn't read the connection parameters properly, or because something went wrong post-connection? I think the tests could provide more useful feedback if these different tests were separated out. But to be sure, this could be said about a lot of our test suite.

A comment about the build step to explain what you wrote here might be nice for future readers.

Thanks.

Actions

Copy link

Updated by Tom Clegg about 1 year ago

Good points.

Added a comment about the "go build" step.

Split test into separate funcs and put the "go build" bin in a SetUpSuite, so now instead of

PASS: container_gateway_test.go:48: ClientSuite.TestShellGateway        5.326s
PASS: container_gateway_test.go:36: ClientSuite.TestShellGatewayNotAvailable    0.742s

we have

PASS: container_gateway_test.go:44: shellSuite.SetUpSuite       2.937s
PASS: container_gateway_test.go:94: shellSuite.TestShellGatewayNotAvailable     0.057s
PASS: container_gateway_test.go:154: shellSuite.TestShellGatewayPortForwarding  0.212s
PASS: container_gateway_test.go:106: shellSuite.TestShellGatewayUsingEnvVars    0.164s
PASS: container_gateway_test.go:109: shellSuite.TestShellGatewayUsingSettingsConf       0.181s
PASS: container_gateway_test.go:90: shellSuite.TearDownSuite    0.875s

20757-ctr-shell-settings @ d69e82869d237a5665142cdfe1d783e8fb49d23d -- developer-run-tests: #3803

Actions

Copy link