Skip to content

Latest commit

 

History

History
152 lines (130 loc) · 5.16 KB

README.md

File metadata and controls

152 lines (130 loc) · 5.16 KB
Raw

storage-commander

Unified way of managing files in various remote storages.

installation

Clone the repository:

git clone https://github.com/EugeneSqr/storage-commander.git
cd storage-commander

Install it with pipx:

pipx install .

Alternatively install with pip even though it's no longer recommended:

pip install .

Copy the .storcom-complete.bash from the root of the cloned project repository to ~/.config/storcom, then source it in bash:

. "$HOME/.config/storcom/.storcom-complete.bash"

To make this change permanent, add the line above to your .bashrc.

development setup

Clone the repository:

git clone https://github.com/EugeneSqr/storage-commander.git
cd storage-commander

Create virtual environment and activate it:

python -m venv env
. env/bin/activate

Install dependencies:

pip install -r requirements.txt

Install the app:

pip install --editable .

configuration

The configuration for all supported storages resides in a single file ~/.config/storcom/config.toml.

It should look something like this:

[dev.fcc]
storage_url = "http://localhost:8000"
[dev.fcc.tokens]
service1 = "xxx"

[qa.cx]
storage_url = "http://qa-api-carrierx.int"
[qa.cx.tokens]
service2 = "yyy"

[shortcuts]
feature_X_on_dev = "dev:fcc:service1:container1"
feature_Y_on_qa = "qa:cx:service2:container2"

Each file location is defined by 4 parameters:

  1. environment - dev, staging, prod etc.
  2. storage - FCC, CX, Amazon S3 (not supported yet) etc.
  3. service - can be called partner, namespace, domain depending on the storage
  4. user - think about it as a container

A combination of these parameters is called a context.

The configuration above defines two distinct storages fcc and cx in two environments dev and qa with tokens for two users user1 and user2. The shortcuts section contains short meaningful names for contexts. The main purpose of shortcuts is to ease switching between the contexts.

usage

Each command is executed within a context. Immediately after the installation the context is empty:

storcom context show
{'environment': '', 'storage': '', 'service': '', 'user': ''}

There are two main ways of setting/changing the context:

  1. Specify each context parameter individually:
storcom context use --environment=dev --storage=fcc --service=service1 --user=container1
{'environment': 'dev', 'storage': 'fcc', 'service': 'service1', 'user': 'container1'}
  1. Use a shortcut specified in the config.toml:
$ storcom context use feature_Y_on_qa
{'environment': 'qa', 'storage': 'cx', 'service': 'service2', 'user': 'container2'}

The context is preserved across app runs in the ~/.config/storcom/.context text file.

After the context is set the app is ready to work with files. Here are some examples:

  1. List all files in a tabular fashion:
storcom file ll
 file_sid                             | name                         | type   | mime_type                   | date_modified
--------------------------------------+------------------------------+--------+-----------------------------+--------------------------
 972ee129-54de-462b-94c3-f42611bf3a6e | 1104-13075222214.vp8         | file   | application/octet-stream    | 2023-01-18T09:36:22.643Z
 e7288d7f-bf89-458f-89de-9f5b9aa87fcb | 1104-13075222214.g722        | audio  | audio/G722                  | 2023-01-18T09:36:22.671Z
  1. Show file details by its ID (piped to jq for clarity). The result HTTP request's curl representation is optionally printed to stderr with --show_curl:
storcom file --show_curl show 972ee129-54de-462b-94c3-f42611bf3a6e | jq
curl -X GET -H 'Accept: */*' -H 'Accept-Encoding: gzip, deflate' -H 'Authorization: Bearer yyy' -H 'Connection: keep-alive' -H 'User-Agent: python-requests/2.31.0' http://qa-api-carrierx.int/core/v2/storage/files/container2
{
  "file_sid": "972ee129-54de-462b-94c3-f42611bf3a6e",
  "partner_sid": "service2",
  "container_sid": "container2",
  "parent_file_sid": null,
  "name": "1104-13075222214.vp8",
  "type": "file",
  "unique": false,
  "file_bytes": 12,
  "file_access_name": "972ee129-54de-462b-94c3-f42611bf3a6e.vp8",
  "publish": "file_sid",
  "publish_uri": "...",
  "lifecycle_ttl": -1,
  "lifecycle_action": "no_action",
  "date_modified": "2023-01-18T09:36:22.643Z",
  "desired_format": null,
  "desired_bitrate": null,
  "mime_type": "application/octet-stream",
  "content_format": "vp8",
  "content_duration": null,
  "content_transcoding_progress": null,
  "threshold_include": true,
  "date_last_accessed": null,
  "content_classification": "unknown"
}
  1. Remove all files:
storcom file ls | jq -r '.items[].file_sid' | xargs storcom file rm

We first list all files as JSON. Then parse the output and extract the ids. We finally use xargs to feed the extracted ids to storcom file rm.

  1. Remove files from storage B which ids present in storage A:
storcom file --context_string=feature_Y_on_qa ls | jq -r '.items[].file_sid' | xargs storcom file --context_string=feature_X_on_dev rm

Note how context gets changed on the fly.