util.py

import docker
import datetime
import socket

from termcolor import colored, cprint

def enum(*sequential, **named):
    """ Represent an enumeration. Originally from: http://stackoverflow.com/questions/36932/whats-the-best-way-to-implement-an-enum-in-python """
    enums = dict(zip(sequential, range(len(sequential))), **named)
    return type('Enum', (), enums)

ReportLevels = enum(BACKGROUND=-2, EXTRA=-1, NORMAL=0, IMPORTANT=1)

client = docker.Client(version='auto')

def pickUnusedPort():
  s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  s.bind(('localhost', 0))
  addr, port = s.getsockname()
  s.close()
  return port

def report(msg, level=ReportLevels.NORMAL, project=None, component=None):
  """ Reports a message to the console. """
  print_string = ''
  if component:
    print_string += colored('[' + component.getName() + '] ', 'green')

  color = 'white'
  attrs = []

  if level == ReportLevels.BACKGROUND or level == ReportLevels.EXTRA:
    attrs.append('dark')
  elif level == ReportLevels.IMPORTANT:
    attrs.append('bold')

  if level == ReportLevels.BACKGROUND:
    dtstring = datetime.datetime.now().strftime("%d/%m/%Y %I:%M%p")
    msg = dtstring + ' | ' + msg

  print_string += colored(msg, color, attrs=attrs)
  print print_string

def fail(reason, project=None, component=None, exception=None):
  """ Fails due to some unexpected error. """
  raise Exception(reason)

def getDockerClient():
  """ Returns the docker client. """
  return client