from testwithirods.api import IrodsVersion
from testwithirods.api import get_static_irods_server_controller

# Controllers available for iRODS version: 3.3.1, 4.1.8, 4.1.9, 4.1.10
Controller = get_static_irods_server_controller(irods_version=IrodsVersion.v4_1_10)
try:
    # Start a server (any number can be started)
    irods_server = Controller.start_server()
    
    # Do interesting things with iRODS...
    
    # Stop a single server
    Controller.stop_server(irods_server)
finally:
    # Ensure all servers are stopped
    Controller.tear_down()

from testwithirods.proxies import ICommandProxyController

proxy_controller = ICommandProxyController(irods_server, "mercury/icat:%s" % irods_server.version)
try:
    icommands_location = proxy_controller.create_proxy_binaries()
    
    # Do interesting things with icommands, linked to the iRODS server
finally:
    proxy_controller.tear_down()

from testwithirods.helpers import SetupHelper, AccessLevel
from testwithirods.models import IrodsResource, IrodsUser, Metadata

setup_helper = SetupHelper("icommands_location")
setup_helper.create_data_object("name", contents="contents")   # type: str
setup_helper.replicate_data_object("/path/to/data_object", "resourceName")
setup_helper.create_collection("name")   # type: str
setup_helper.add_metadata_to("/path/to/entity", Metadata({"attribute": "value"}))
setup_helper.get_checksum("/path/to/entity")   # type: str
setup_helper.create_replica_storage()   # type: IrodsResource
setup_helper.create_user("username", "zone")    # type: IrodsUser
setup_helper.set_access("username_or_group", AccessLevel.OWN, "/path/to/entity")
setup_helper.run_icommand(["icommand_binary", "--any", "arguments"])    # type: str