algorithms.py 15.2 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):
André Anjos's avatar
André Anjos committed
58 59 60 61 62 63 64 65 66 67
  """Copies algorithms (and required libraries/dataformats) from the server.

  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

  status, names = common.pull(webapi, prefix, 'algorithm', names,
Philip ABBET's avatar
Philip ABBET committed
100
                              ['declaration', 'code', 'description'], force, indentation)
André Anjos's avatar
André Anjos committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

  if status != 0: return status

  # see what dataformats one needs to pull
  indent = indentation * ' '

  dataformats = []
  libraries = []
  for name in names:
    obj = algorithm.Algorithm(prefix, name)
    dataformats.extend(obj.dataformats.keys())
    libraries.extend(obj.libraries.keys())

  # downloads any formats to which we depend on
  df_status = dataformats_pull(webapi, prefix, dataformats, force,
Philip ABBET's avatar
Philip ABBET committed
116
                               indentation + 2, format_cache)
André Anjos's avatar
André Anjos committed
117 118

  lib_status = libraries_pull(webapi, prefix, libraries, force,
Philip ABBET's avatar
Philip ABBET committed
119
                              indentation + 2, lib_cache)
André Anjos's avatar
André Anjos committed
120 121 122 123

  return status + df_status + lib_status


124 125

def print_examples():
126
    print("""
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
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
144
          "channel": "main"
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
        }
    },
    "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
171
          "channel": "main"
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
        }
    },
    "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>"
    }
}
204
""")
205 206 207



208
def execute_impl(prefix, cache, instructions_file):
209 210 211 212 213 214 215 216 217 218 219 220
  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

221
    if 'parameters' not in configuration:
222 223 224 225
      configuration['parameters'] = {}

    for name, cfg in configuration['inputs'].items():
      cfg['endpoint'] = name
226
      suffix = ''
227
      if 'database' in cfg:   # Connected to a database output
228 229 230 231
        cfg['hash'] = hash.hashDataset(cfg['database'], cfg['protocol'], cfg['set'])
        suffix = '.db'

      cfg['path'] = hash.toPath(cfg['hash'], suffix=suffix)
232 233 234

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

235
    if 'outputs' in  configuration:   # Standard algorithm
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
      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(
Philip ABBET's avatar
Philip ABBET committed
252
          'block',
253 254 255 256 257
              configuration['algorithm'],
              algo.hash(),
              configuration['parameters'],
              configuration['environment'],
              dict([(k, v['hash']) for k, v in configuration['inputs'].items()]),
Philip ABBET's avatar
Philip ABBET committed
258
      )
259 260 261 262 263 264 265
      configuration['result']['path'] = hash.toPath(configuration['result']['hash'], '')

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

Philip ABBET's avatar
Philip ABBET committed
266
    host = Host(raise_on_errors=False)
267

268 269
    executor = DockerExecutor(host, prefix, configuration, cache, dataformat_cache,
                              database_cache, algorithm_cache)
270 271 272 273 274 275 276

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

    # Execute the algorithm
    with executor:
Philip ABBET's avatar
Philip ABBET committed
277
      result = executor.process()
278
      if result['status'] != 0:
279 280
          print('STDERR:')
          print(result['stderr'])
281 282

    # Display the results
283
    if 'outputs' in configuration:   # Standard algorithm
284
      print('Outputs of the algorithms available at:')
285
      for name, cfg in configuration['outputs'].items():
286
        print('  - %s: %s' % (name, cfg['path']))
287
    else:
288
      print('Results of the analyzer available at: %s' % configuration['result']['path'])
289 290 291 292 293 294 295 296 297 298

  except Exception as e:
    import traceback
    logger.error(traceback.format_exc())
    return 1

  return 0



299
@click.group(cls=AliasedGroup)
300 301 302 303 304 305 306 307 308
@click.pass_context
def algorithms(ctx):
    """Configuration and manipulation of algorithms"""
    pass

@algorithms.command()
@click.option('--remote', help='Only acts on the remote copy of the algorithm',
              is_flag=True)
@click.pass_context
309
@raise_on_error
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
def list(ctx, remote):
  '''Lists all the algorithms available on the platform

  Example:
    $ beat algorithms list --remote
  '''
  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')

@algorithms.command()
@click.argument('names', nargs=-1)
@click.pass_context
325
@raise_on_error
326 327
def path(ctx, names):
  '''Displays local path of algorithm files
André Anjos's avatar
André Anjos committed
328

329 330 331 332 333 334 335 336 337
  Example:
    $ beat algorithms path xxx
  '''
  return common.display_local_path(ctx.meta['config'].path, 'algorithm', names)


@algorithms.command()
@click.argument('name', nargs=1)
@click.pass_context
338
@raise_on_error
339 340
def edit(ctx, name):
  '''Edit local algorithm file
André Anjos's avatar
André Anjos committed
341

342 343 344 345 346 347
  Example:
    $ beat algorithms edit xxx
  '''
  return common.edit_local_file(ctx.meta['config'].path,
                                ctx.meta['config'].editor, 'algorithm',
                                name)
348

349

350
@algorithms.command()
351
@click.argument('name', nargs=-1)
352
@click.pass_context
353
@raise_on_error
354 355
def check(ctx, name):
  '''Checks a local algorithm for validity
André Anjos's avatar
André Anjos committed
356

357 358 359 360
  Example:
    $ beat algorithms check xxx
  '''
  return common.check(ctx.meta['config'].path, 'algorithm', name)
André Anjos's avatar
André Anjos committed
361 362 363



364
@algorithms.command()
365
@click.argument('name', nargs=-1)
366 367 368
@click.option('--force', help='Performs operation regardless of conflicts',
              is_flag=True)
@click.pass_context
369
@raise_on_error
370 371
def pull(ctx, name, force):
  '''Downloads the specified algorithms from the server
André Anjos's avatar
André Anjos committed
372

373 374 375 376 377
  Example:
    $ beat algorithms pull --force yyy
  '''
  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
378 379 380



381

382
@algorithms.command()
383
@click.argument('name', nargs=-1)
384 385 386 387 388
@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)
@click.pass_context
389
@raise_on_error
390 391
def push(ctx, name, force, dry_run):
  '''Uploads algorithms to the server
392

393 394 395 396 397 398 399
  Example:
    $ beat algorithms push --dry-run yyy
  '''
  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)
400

André Anjos's avatar
André Anjos committed
401

402 403 404 405

@algorithms.command()
@click.argument('name', nargs=1)
@click.pass_context
406
@raise_on_error
407 408 409 410 411 412 413 414 415 416 417 418 419 420
def diff(ctx, name):
  '''Shows changes between the local algorithm and the remote version

  Example:
    $ beat algorithms diff xxx
  '''
  with common.make_webapi(ctx.meta['config']) as webapi:
    return common.diff(webapi, ctx.meta['config'].path, 'algorithm',
                       name, ['declaration', 'code', 'description'])



@algorithms.command()
@click.pass_context
421
@raise_on_error
422 423 424 425 426 427 428 429 430 431 432 433
def status(ctx):
  '''Shows (editing) status for all available algorithms

  Example:
    $ beat algorithms status
  '''
  with common.make_webapi(ctx.meta['config']) as webapi:
    return common.status(webapi, ctx.meta['config'].path, 'algorithm')[0]



@algorithms.command()
434
@click.argument('name', nargs=-1)
435
@click.pass_context
436
@raise_on_error
437 438 439 440 441 442
def create(ctx, name):
  '''Creates a new local algorithm

  Example:
    $ beat algorithms create xxx
  '''
443
  return common.create(ctx.meta['config'].path, 'algorithm', name)
444 445 446 447 448 449



@algorithms.command()
@click.argument('name', nargs=1)
@click.pass_context
450
@raise_on_error
451 452 453 454 455 456 457 458 459 460 461 462 463 464
def version(ctx, name):
  '''Creates a new version of an existing algorithm

  Example:
    $ beat algorithms version xxx
  '''
  return common.new_version(ctx.meta['config'].path, 'algorithm', name)



@algorithms.command()
@click.argument('src', nargs=1)
@click.argument('dst', nargs=1)
@click.pass_context
465
@raise_on_error
466 467 468 469 470 471 472 473 474 475 476
def fork(ctx, src, dst):
  '''Forks a local algorithm

  Example:
      $ beat algorithms fork xxx yyy
  '''
  return common.fork(ctx.meta['config'].path, 'algorithm', src, dst)



@algorithms.command()
477
@click.argument('name', nargs=-1)
478 479 480
@click.option('--remote', help='Only acts on the remote copy of the algorithm',
              is_flag=True)
@click.pass_context
481
@raise_on_error
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
def rm(ctx, name, remote):
  '''Deletes a local algorithm (unless --remote is specified)

  Example:
      $ beat algorithms rm xxx
  '''
  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)



@algorithms.command()
497
@click.argument('instructions', nargs=1)
498 499 500
@click.option('--example', help='Display some example JSON instruction files',
              is_flag=True)
@click.pass_context
501
@raise_on_error
502 503 504 505 506 507 508 509 510 511 512
def execute(ctx, instructions, example):
  '''Execute an algorithm following instructions in a JSON file

  Example:
    $ beat algorithms execute <instructions>
    $ beat algorithms execute --examples
  '''
  if example:
    print_examples()
    return 0

513 514
  return execute_impl(ctx.meta['config'].path, ctx.meta['config'].cache,
                      instructions)