algorithms.py 15.9 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
###################################################################################
#                                                                                 #
# Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/               #
# Contact: beat.support@idiap.ch                                                  #
#                                                                                 #
# Redistribution and use in source and binary forms, with or without              #
# modification, are permitted provided that the following conditions are met:     #
#                                                                                 #
# 1. Redistributions of source code must retain the above copyright notice, this  #
# list of conditions and the following disclaimer.                                #
#                                                                                 #
# 2. Redistributions in binary form must reproduce the above copyright notice,    #
# this list of conditions and the following disclaimer in the documentation       #
# and/or other materials provided with the distribution.                          #
#                                                                                 #
# 3. Neither the name of the copyright holder nor the names of its contributors   #
# may be used to endorse or promote products derived from this software without   #
# specific prior written permission.                                              #
#                                                                                 #
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND #
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED   #
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE          #
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE    #
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL      #
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR      #
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER      #
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,   #
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE   #
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.            #
#                                                                                 #
###################################################################################

André Anjos's avatar
André Anjos committed
36

37
import click
André Anjos's avatar
André Anjos committed
38
import logging
39 40 41
import os
import simplejson as json

André Anjos's avatar
André Anjos committed
42 43

from beat.core import algorithm
44
from beat.core.execution import DockerExecutor
45 46 47 48
from beat.core.dock import Host
from beat.core import hash
from beat.backend.python.algorithm import Storage as AlgorithmStorage

49 50
from . import common
from .decorators import raise_on_error
51 52
from .click_helper import AliasedGroup

André Anjos's avatar
André Anjos committed
53

54
logger = logging.getLogger(__name__)
André Anjos's avatar
André Anjos committed
55

56 57

def pull_impl(webapi, prefix, names, force, indentation, format_cache, lib_cache):
58
    """Copies algorithms (and required libraries/dataformats) from the server.
André Anjos's avatar
André Anjos committed
59 60 61 62 63 64 65 66 67

  Parameters:

    webapi (object): An instance of our WebAPI class, prepared to access the
      BEAT server of interest

    prefix (str): A string representing the root of the path in which the user
      objects are stored

André Anjos's avatar
André Anjos committed
68 69 70 71 72
    names (:py:class:`list`): A list of strings, each representing the unique
      relative path of the objects to retrieve or a list of usernames from
      which to retrieve objects. If the list is empty, then we pull all
      available objects of a given type. If no user is set, then pull all
      public objects of a given type.
André Anjos's avatar
André Anjos committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

    force (bool): If set to ``True``, then overwrites local changes with the
      remotely retrieved copies.

    indentation (int): The indentation level, useful if this function is called
      recursively while downloading different object types. This is normally
      set to ``0`` (zero).

    format_cache (dict): A dictionary containing all dataformats already
      downloaded.

    lib_cache (dict): A dictionary containing all libraries already
      downloaded.


  Returns:

    int: Indicating the exit status of the command, to be reported back to the
      calling process. This value should be zero if everything works OK,
      otherwise, different than zero (POSIX compliance).

  """

96 97
    from .dataformats import pull_impl as dataformats_pull
    from .libraries import pull_impl as libraries_pull
André Anjos's avatar
André Anjos committed
98

99 100 101 102 103 104 105 106 107
    status, names = common.pull(
        webapi,
        prefix,
        "algorithm",
        names,
        ["declaration", "code", "description"],
        force,
        indentation,
    )
André Anjos's avatar
André Anjos committed
108

109 110
    if status != 0:
        return status
André Anjos's avatar
André Anjos committed
111

112 113 114
    # see what dataformats one needs to pull
    if indentation == 0:
        indentation = 4
André Anjos's avatar
André Anjos committed
115

116 117 118 119 120 121
    dataformats = []
    libraries = []
    for name in names:
        obj = algorithm.Algorithm(prefix, name)
        dataformats.extend(obj.dataformats.keys())
        libraries.extend(obj.libraries.keys())
André Anjos's avatar
André Anjos committed
122

123 124 125 126
    # downloads any formats to which we depend on
    df_status = dataformats_pull(
        webapi, prefix, dataformats, force, indentation, format_cache
    )
André Anjos's avatar
André Anjos committed
127

128 129 130
    lib_status = libraries_pull(
        webapi, prefix, libraries, force, indentation, lib_cache
    )
André Anjos's avatar
André Anjos committed
131

132
    return status + df_status + lib_status
André Anjos's avatar
André Anjos committed
133

134 135

def print_examples():
136 137
    print(
        """
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
To feed data from a database to an algorithm:
=============================================

{
    "algorithm": "<username>/<algorithm>/<version>",
    "channel": "main",
    "inputs": {
        "<input_name>": {
            "database": "<database>/<version>",
            "protocol": "<protocol>",
            "set": "<set>",
            "output": "<output_name>",
            "channel": "main"
        }
    },
    "outputs": {
        "<output_name>": {
Philip ABBET's avatar
Philip ABBET committed
155
          "channel": "main"
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
        }
    },
    "parameters": {
      "<parameter_name>": <value>
    },
    "environment": {
        "name": "<environment_name>",
        "version": "<environment_version>"
    }
}


To feed data from a file in the cache:
======================================

{
    "algorithm": "<username>/<algorithm>/<version>",
    "channel": "main",
    "inputs": {
        "<input_name>": {
            "hash": "<hash>",
            "channel": "main"
        }
    },
    "outputs": {
        "<output_name>": {
Philip ABBET's avatar
Philip ABBET committed
182
          "channel": "main"
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
        }
    },
    "parameters": {
      "<parameter_name>": <value>
    },
    "environment": {
        "name": "<environment_name>",
        "version": "<environment_version>"
    }
}


To execute an analyzer:
=======================

{
    "algorithm": "<username>/<algorithm>/<version>",
    "channel": "main",
    "inputs": {
        "<input_name>": {
            "hash": "<hash>",
            "channel": "main"
        }
    },
    "parameters": {
      "<parameter_name>": <value>
    },
    "environment": {
        "name": "<environment_name>",
        "version": "<environment_version>"
    }
}
215 216
"""
    )
217 218


219
def execute_impl(prefix, cache, instructions_file):
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    try:
        # Load the JSON configuration
        if not os.path.exists(instructions_file):
            raise IOError("JSON instructions file `%s' not found" % instructions_file)

        with open(instructions_file, "r") as f:
            configuration = json.load(f)

        # Add missing configuration fields
        configuration["queue"] = "unused"
        configuration["nb_slots"] = 1

        if "parameters" not in configuration:
            configuration["parameters"] = {}

        for name, cfg in configuration["inputs"].items():
            cfg["endpoint"] = name
            suffix = ""
            if "database" in cfg:  # Connected to a database output
                cfg["hash"] = hash.hashDataset(
                    cfg["database"], cfg["protocol"], cfg["set"]
                )
                suffix = ".db"

            cfg["path"] = hash.toPath(cfg["hash"], suffix=suffix)

        algo = AlgorithmStorage(prefix, configuration["algorithm"])

        if "outputs" in configuration:  # Standard algorithm
            for name, cfg in configuration["outputs"].items():
                cfg["endpoint"] = name
                cfg["hash"] = hash.hashBlockOutput(
                    "block",
                    configuration["algorithm"],
                    algo.hash(),
                    configuration["parameters"],
                    configuration["environment"],
                    dict([(k, v["hash"]) for k, v in configuration["inputs"].items()]),
                    name,
                )
                cfg["path"] = hash.toPath(cfg["hash"], "")

        else:  # Analyzer
            configuration["result"] = {}
            configuration["result"]["hash"] = hash.hashAnalyzer(
                "block",
                configuration["algorithm"],
                algo.hash(),
                configuration["parameters"],
                configuration["environment"],
                dict([(k, v["hash"]) for k, v in configuration["inputs"].items()]),
            )
            configuration["result"]["path"] = hash.toPath(
                configuration["result"]["hash"], ""
            )

        # Sets up the execution
        dataformat_cache = {}
        database_cache = {}
        algorithm_cache = {}

        host = Host(raise_on_errors=False)

        executor = DockerExecutor(
            host,
            prefix,
            configuration,
            cache,
            dataformat_cache,
            database_cache,
            algorithm_cache,
        )

        if not executor.valid:
            logger.error(
                "Invalid configuration:\n  * %s" % "\n  * ".join(executor.errors)
            )
            return 1

        # Execute the algorithm
        with executor:
            result = executor.process()
            if result["status"] != 0:
                print("STDERR:")
                print(result["stderr"])

        # Display the results
        if "outputs" in configuration:  # Standard algorithm
            print("Outputs of the algorithms available at:")
            for name, cfg in configuration["outputs"].items():
                print("  - %s: %s" % (name, cfg["path"]))
        else:
            print(
                "Results of the analyzer available at: %s"
                % configuration["result"]["path"]
            )

    except Exception:
        import traceback

        logger.error(traceback.format_exc())
        return 1
322

323
    return 0
324 325


326
@click.group(cls=AliasedGroup)
327 328 329 330 331
@click.pass_context
def algorithms(ctx):
    """Configuration and manipulation of algorithms"""
    pass

332

333
@algorithms.command()
334 335 336
@click.option(
    "--remote", help="Only acts on the remote copy of the algorithm", is_flag=True
)
337
@click.pass_context
338
@raise_on_error
339
def list(ctx, remote):
340
    """Lists all the algorithms available on the platform
341 342 343

  Example:
    $ beat algorithms list --remote
344 345 346 347 348 349 350
  """
    if remote:
        with common.make_webapi(ctx.meta["config"]) as webapi:
            return common.display_remote_list(webapi, "algorithm")
    else:
        return common.display_local_list(ctx.meta["config"].path, "algorithm")

351 352

@algorithms.command()
353
@click.argument("names", nargs=-1)
354
@click.pass_context
355
@raise_on_error
356
def path(ctx, names):
357
    """Displays local path of algorithm files
André Anjos's avatar
André Anjos committed
358

359 360
  Example:
    $ beat algorithms path xxx
361 362
  """
    return common.display_local_path(ctx.meta["config"].path, "algorithm", names)
363 364 365


@algorithms.command()
366
@click.argument("name", nargs=1)
367
@click.pass_context
368
@raise_on_error
369
def edit(ctx, name):
370
    """Edit local algorithm file
André Anjos's avatar
André Anjos committed
371

372 373
  Example:
    $ beat algorithms edit xxx
374 375 376 377
  """
    return common.edit_local_file(
        ctx.meta["config"].path, ctx.meta["config"].editor, "algorithm", name
    )
378

379

380
@algorithms.command()
381
@click.argument("name", nargs=-1)
382
@click.pass_context
383
@raise_on_error
384
def check(ctx, name):
385
    """Checks a local algorithm for validity
André Anjos's avatar
André Anjos committed
386

387 388
  Example:
    $ beat algorithms check xxx
389 390
  """
    return common.check(ctx.meta["config"].path, "algorithm", name)
André Anjos's avatar
André Anjos committed
391 392


393
@algorithms.command()
394 395 396 397
@click.argument("name", nargs=-1)
@click.option(
    "--force", help="Performs operation regardless of conflicts", is_flag=True
)
398
@click.pass_context
399
@raise_on_error
400
def pull(ctx, name, force):
401
    """Downloads the specified algorithms from the server
André Anjos's avatar
André Anjos committed
402

403 404
  Example:
    $ beat algorithms pull --force yyy
405 406 407
  """
    with common.make_webapi(ctx.meta["config"]) as webapi:
        return pull_impl(webapi, ctx.meta["config"].path, name, force, 0, {}, {})
André Anjos's avatar
André Anjos committed
408

409

410
@algorithms.command()
411 412 413 414 415 416 417 418 419
@click.argument("name", nargs=-1)
@click.option(
    "--force", help="Performs operation regardless of conflicts", is_flag=True
)
@click.option(
    "--dry-run",
    help="Doesn't really perform the task, just " "comments what would do",
    is_flag=True,
)
420
@click.pass_context
421
@raise_on_error
422
def push(ctx, name, force, dry_run):
423
    """Uploads algorithms to the server
424

425 426
  Example:
    $ beat algorithms push --dry-run yyy
427 428 429 430 431 432 433 434 435 436 437 438 439
  """
    with common.make_webapi(ctx.meta["config"]) as webapi:
        return common.push(
            webapi,
            ctx.meta["config"].path,
            "algorithm",
            name,
            ["name", "declaration", "code", "description"],
            {},
            force,
            dry_run,
            0,
        )
André Anjos's avatar
André Anjos committed
440

441 442

@algorithms.command()
443
@click.argument("name", nargs=1)
444
@click.pass_context
445
@raise_on_error
446
def diff(ctx, name):
447
    """Shows changes between the local algorithm and the remote version
448 449 450

  Example:
    $ beat algorithms diff xxx
451 452 453 454 455 456 457 458 459
  """
    with common.make_webapi(ctx.meta["config"]) as webapi:
        return common.diff(
            webapi,
            ctx.meta["config"].path,
            "algorithm",
            name,
            ["declaration", "code", "description"],
        )
460 461 462 463


@algorithms.command()
@click.pass_context
464
@raise_on_error
465
def status(ctx):
466
    """Shows (editing) status for all available algorithms
467 468 469

  Example:
    $ beat algorithms status
470 471 472
  """
    with common.make_webapi(ctx.meta["config"]) as webapi:
        return common.status(webapi, ctx.meta["config"].path, "algorithm")[0]
473 474 475


@algorithms.command()
476
@click.argument("name", nargs=-1)
477
@click.pass_context
478
@raise_on_error
479
def create(ctx, name):
480
    """Creates a new local algorithm
481 482 483

  Example:
    $ beat algorithms create xxx
484 485
  """
    return common.create(ctx.meta["config"].path, "algorithm", name)
486 487 488


@algorithms.command()
489
@click.argument("name", nargs=1)
490
@click.pass_context
491
@raise_on_error
492
def version(ctx, name):
493
    """Creates a new version of an existing algorithm
494 495 496

  Example:
    $ beat algorithms version xxx
497 498
  """
    return common.new_version(ctx.meta["config"].path, "algorithm", name)
499 500 501


@algorithms.command()
502 503
@click.argument("src", nargs=1)
@click.argument("dst", nargs=1)
504
@click.pass_context
505
@raise_on_error
506
def fork(ctx, src, dst):
507
    """Forks a local algorithm
508 509 510

  Example:
      $ beat algorithms fork xxx yyy
511 512
  """
    return common.fork(ctx.meta["config"].path, "algorithm", src, dst)
513 514 515


@algorithms.command()
516 517 518 519
@click.argument("name", nargs=-1)
@click.option(
    "--remote", help="Only acts on the remote copy of the algorithm", is_flag=True
)
520
@click.pass_context
521
@raise_on_error
522
def rm(ctx, name, remote):
523
    """Deletes a local algorithm (unless --remote is specified)
524 525 526

  Example:
      $ beat algorithms rm xxx
527 528 529 530 531 532
  """
    if remote:
        with common.make_webapi(ctx.meta["config"]) as webapi:
            return common.delete_remote(webapi, "algorithm", name)
    else:
        return common.delete_local(ctx.meta["config"].path, "algorithm", name)
533 534 535


@algorithms.command()
536 537 538 539
@click.argument("instructions", nargs=1)
@click.option(
    "--example", help="Display some example JSON instruction files", is_flag=True
)
540
@click.pass_context
541
@raise_on_error
542
def execute(ctx, instructions, example):
543
    """Execute an algorithm following instructions in a JSON file
544 545 546 547

  Example:
    $ beat algorithms execute <instructions>
    $ beat algorithms execute --examples
548 549 550 551
  """
    if example:
        print_examples()
        return 0
552

553
    return execute_impl(ctx.meta["config"].path, ctx.meta["config"].cache, instructions)