nspcc-dev / nspcc-dev/neofs-node

We need to make the change API process more clear for changing tests.

Open
#1,877 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

blocked discussion I2 S2 U3
Dominant language
Go
Stars
38
Forks
51
Avg merge
1d 20h
Merged PRs (30d)
38

Description

After API was changed we had output json changed too, as result our tests which use parsing output json had broken.
For example:
the old output was:

COMMAND: 'neofs-cli --config /tests/neofs_cli_configs/empty_passwd.yml object head --rpc-endpoint 'obj-nn-test-node1.spb.yadro.com:8081' --wallet '/tests/TemporaryDir/9e36c117-375a-4bb9-98d4-4069ed75bd85.json' --cid '5bx2Sf6QGH1cwPYygKXbnci54c2r4B7U57nyKqJKSn3F' --oid 'DBLVipfwZ2RidS8VHtEHuytTWPxWm7RCQCrmwfGoaNxt' --json'
OUTPUT:
...
"object":{
		"verb":"DELETE", 
		"address":{
			"containerID":{
					"value":"RGK2R6ck2MYpZwA0fDZjzkEhLNh+jQPy1ppvinOvM34="
					}, 
			"objectID":{"value":"L0Npxk176tmA5R8TG1KUgrKg3PDmyeH4CJ/wwp3oTfA="}
			}}}, 
...

the new output is:

COMMAND: 'neofs-cli --config /tests/wallet_config.yml object head --rpc-endpoint 'obj-nn-test-node2.spb.yadro.com:8081' --wallet '/tests/TemporaryDir/05e48067-b192-429f-973d-d336a449a5d6.json' --cid '43qM2vL1PEUgJ8JDaRqD9YjZW5D8q6QWxUgWbwy6hjib' --oid '3Gyij4fKgWMM5ut75FjP6bpoUWQmYQpVgE1UYhRxKXqU' --json'
OUTPUT:
...
		"object":{
			"verb":"DELETE", 
			"target":{"container":{"value":"LUzi/6K59Svl6oq02HEtf5o1pzVNHtn/4MJe9/rCQWQ="}, 
			"objects":[{"value":"q7OWeKaYaCr+q11OkmA0JiFRaSHCAGOF9K2OsehOeR0="}]}
		}}, 
...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue provides old and new JSON output for the object head API and says tests that parse the output broke, but it names no files or tests. Start by locating tests that parse this output and the API change that altered the object shape; done means the change process and required test updates are clearly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, documentation, testing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.