Stephan's attempt at figuring stuff out

[jsheunis]

Context

In an attempt to become skilled enough to eventually contribute usefully to this extension's codebase, I will try to figure out as much as I can from existing RIA code in core, as well as all the open issues in this current repo. I will document my findings here.

Sources

Let's start with what I could find as sources of information about RIA, including the codebase:

• Handbook chapter: https://handbook.datalad.org/en/latest/beyond_basics/101-147-riastores.html
• Developer docs: https://docs.datalad.org/en/stable/generated/man/datalad-create-sibling-ria.html
• A stale attempt at making more comprehensive docs: https://github.com/datalad/ria-tools/pull/1/files#diff-f23678b4c439fd130355644fa4c36770a302e257cc841883c4c11d74918e6e32R118
• Something about ria-tools: https://github.com/datalad/ria-tools
• Code @ datalad/customremotes/ria_remote.py - seems to be deprecated functionality
• Code @ datalad/customremotes/ria_utils.py - perhaps this is still used as helper code elsewhere?
• Code @ datalad/distributed/create_sibling_ria.py - the main RIA sibling interface
• Code @ datalad/distributedexport_archive_ora.py - interface to create archive in RIA store
• Code @ datalad/distributed/ora_remote.py - the ORA special remote
• Tests:
  • Test utils: https://github.com/datalad/datalad/blob/maint/datalad/distributed/tests/ria_utils.py
  • test_create_sibling_ria
  • test_ora_http
  • test_ria
  • test_ria_basics
  • test_ria_git_remote

[adswa]

Code @ datalad/customremotes/ria_utils.py - perhaps this is still used as helper code elsewhere?

Yes, the functions in this file are heavily used, and most of the ria functionality relies on (some of) them.

[jsheunis]

Getting tests to run on a Mac

Noting the steps that I followed to get tests (at state: https://github.com/datalad/datalad-ria/commit/771feb6b0122da46f21abc37f65ad7b05901492d) to succeed locally.

1. Make sure SSH keys correctly set up for connecting to localhost

# 1. Check extisting ssh config, specifically the identity file
>> cat ~/.ssh/config

Host *
  AddKeysToAgent yes
  UseKeychain yes
  IdentityFile ~/.ssh/id_ed25519

# 2. Add identity to ssh-agent
>> ssh-add -K ~/.ssh/id_ed25519

Identity added: /Users/jsheunis/.ssh/id_ed25519 (s.heunis@fz-juelich.de)

# 3. Add identify public key to authorized keys
>> cat ~/.ssh/id_ed25519.pub >> ~/.ssh/authorized_keys

# 4. set user/owner access permissions
>> chmod 700 ~/.ssh
>> chmod 600 ~/.ssh/authorized_keys

2. Start a local ssh server

• Option 1 Point and click: System Preferences -> Sharing - Check Remote login
• Option 2 via terminal: sudo systemsetup -setremotelogin on

3. Run tests

(after datalad-ria installation in a local virtual environment)

python -m pytest -s -vv datalad_ria/tests