rwlaunchpad/plugins/rwstagingmgr/rift/tasklets/rwstagingmgr/store/file_store.py

   1 """
   2 #
   3 #   Copyright 2016 RIFT.IO Inc
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 #
  17
  18 @file file_store.py
  19 @author Varun Prasad (varun.prasad@riftio.com)
  20 @date 28-Sep-2016
  21
  22 """
  23
  24 import logging
  25 import os
  26 import shutil
  27 import tempfile
  28 import time
  29 import uuid
  30 import yaml
  31
  32 import gi
  33 gi.require_version("RwStagingMgmtYang", "1.0")
  34 from gi.repository import RwStagingMgmtYang
  35 import rift.mano.dts as mano_dts
  36
  37 from .. import model
  38 from ..protocol import StagingStorePublisherProtocol
  39
  40
  41 class StagingAreaExists(Exception):
  42     pass
  43
  44 class InvalidStagingArea(Exception):
  45     pass
  46
  47 class StagingStructureError(Exception):
  48     pass
  49
  50 class StagingFileStore(StagingStorePublisherProtocol):
  51     """File based store for creating and managing staging areas.
  52     """
  53     META_YAML = "meta.yaml"
  54     DEFAULT_EXPIRY = 60 * 60
  55
  56     def __init__(self, log=None, root_dir=None):
  57         default_path = os.path.join(
  58             os.getenv('RIFT_ARTIFACTS'),
  59             "launchpad/staging")
  60
  61         self.root_dir = root_dir or default_path
  62
  63         if not os.path.isdir(self.root_dir):
  64             os.makedirs(self.root_dir)
  65
  66         self.log = log or logging.getLogger()
  67         self.tmp_dir = tempfile.mkdtemp(dir=self.root_dir)
  68
  69         self._cache = {}
  70         self.delegate = None
  71
  72     def on_recovery(self, staging_areas):
  73         for area in staging_areas:
  74             staging_area = model.StagingArea(area)
  75             self._cache[area.area_id] = staging_area
  76
  77
  78     def get_staging_area(self, area_id):
  79         if area_id not in self._cache:
  80             raise InvalidStagingArea
  81
  82         return self._cache[area_id]
  83
  84
  85     def create_staging_area(self, staging_area_config):
  86         """Create the staging area
  87         Args:
  88             staging_area_config (YangInput_RwStagingMgmt_CreateStagingArea): Rpc input
  89
  90         Returns:
  91             model.StagingArea
  92
  93         Raises:
  94             StagingAreaExists: if the staging area already exists
  95         """
  96         area_id = str(uuid.uuid4())
  97
  98         container_path = os.path.join(self.root_dir, str(area_id))
  99         meta_path = os.path.join(container_path, self.META_YAML)
 100
 101         if os.path.exists(container_path):
 102             raise StagingAreaExists
 103
 104         # Create the dir
 105         os.makedirs(container_path)
 106
 107         config_dict = staging_area_config.as_dict()
 108         config_dict.update({
 109             "area_id": area_id,
 110             "created_time": time.time(),
 111             "status": "LIVE",
 112             "path": container_path
 113             })
 114
 115         staging_area = RwStagingMgmtYang.StagingArea.from_dict(config_dict)
 116         staging_area = model.StagingArea(staging_area)
 117
 118         self._cache[area_id] = staging_area
 119
 120         try:
 121             if self.delegate:
 122                 self.delegate.on_staging_area_create(staging_area.model)
 123         except Exception as e:
 124             self.log.exception(str(e))
 125
 126         return staging_area
 127
 128     def remove_staging_area(self, staging_area):
 129         """Delete the staging area
 130         Args:
 131             staging_area (str or model.StagingArea): Staging ID or the
 132                 StagingArea object
 133         """
 134         if type(staging_area) is str:
 135             staging_area = self.get_staging_area(staging_area)
 136
 137         if os.path.isdir(staging_area.model.path):
 138             shutil.rmtree(staging_area.model.path)
 139
 140         staging_area.model.status = "EXPIRED"
 141
 142         try:
 143             if self.delegate:
 144                 self.delegate.on_staging_area_delete(staging_area.model)
 145         except Exception as e:
 146             self.log.exception(str(e))