Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

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

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

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

171

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

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

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

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

# Copyright 2013 UnitedStack Inc. 

# All Rights Reserved. 

# 

#    Licensed under the Apache License, Version 2.0 (the "License"); you may 

#    not use this file except in compliance with the License. You may obtain 

#    a copy of the License at 

# 

#         http://www.apache.org/licenses/LICENSE-2.0 

# 

#    Unless required by applicable law or agreed to in writing, software 

#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 

#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 

#    License for the specific language governing permissions and limitations 

#    under the License. 

 

import datetime 

 

import pecan 

from pecan import rest 

import wsme 

from wsme import types as wtypes 

import wsmeext.pecan as wsme_pecan 

 

from magnum.api.controllers import base 

from magnum.api.controllers import link 

from magnum.api.controllers.v1 import collection 

from magnum.api.controllers.v1 import types 

from magnum.api.controllers.v1 import utils as api_utils 

from magnum.common import exception 

from magnum import objects 

from magnum.openstack.common import log as logging 

 

LOG = logging.getLogger(__name__) 

 

 

class ContainerPatchType(types.JsonPatchType): 

 

    @staticmethod 

    def mandatory_attrs(): 

        return ['/bay_uuid'] 

 

 

class Container(base.APIBase): 

    """API representation of a container. 

 

    This class enforces type checking and value constraints, and converts 

    between the internal object model and the API representation of a 

    container. 

    """ 

 

    _bay_uuid = None 

 

    def _get_bay_uuid(self): 

        return self._bay_uuid 

 

    def _set_bay_uuid(self, value): 

        if value and self._bay_uuid != value: 

            try: 

                bay = objects.Bay.get_by_uuid(pecan.request.context, value) 

                self._bay_uuid = bay['uuid'] 

            except exception.BayNotFound as e: 

                # Change error code because 404 (NotFound) is inappropriate 

                # response for a POST request to create a Service 

                e.code = 400  # BadRequest 

                raise e 

exit        elif value == wtypes.Unset: 

            self._bay_uuid = wtypes.Unset 

 

    uuid = types.uuid 

    """Unique UUID for this container""" 

 

    name = wtypes.StringType(min_length=1, max_length=255) 

    """Name of this container""" 

 

    image_id = wtypes.text 

    """The image name or UUID to use as a base image for this baymodel""" 

 

    bay_uuid = wsme.wsproperty(types.uuid, _get_bay_uuid, _set_bay_uuid, 

                               mandatory=True) 

    """Unique UUID of the bay this runs on""" 

 

    links = wsme.wsattr([link.Link], readonly=True) 

    """A list containing a self link and associated container links""" 

 

    command = wtypes.text 

    """The command execute when container starts""" 

 

    status = wtypes.text 

    """The status of container""" 

 

    def __init__(self, **kwargs): 

        self.fields = [] 

        for field in objects.Container.fields: 

            # Skip fields we do not expose. 

            if not hasattr(self, field): 

                continue 

            self.fields.append(field) 

            setattr(self, field, kwargs.get(field, wtypes.Unset)) 

 

    @staticmethod 

    def _convert_with_links(container, url, expand=True): 

        if not expand: 

            container.unset_fields_except(['uuid', 'name', 'bay_uuid', 

                                           'image_id', 'command', 'status']) 

 

        container.links = [link.Link.make_link('self', url, 

                                          'containers', container.uuid), 

                      link.Link.make_link('bookmark', url, 

                                          'containers', container.uuid, 

                                          bookmark=True) 

                     ] 

        return container 

 

    @classmethod 

    def convert_with_links(cls, rpc_container, expand=True): 

        container = Container(**rpc_container.as_dict()) 

        return cls._convert_with_links(container, pecan.request.host_url, 

                                       expand) 

 

    @classmethod 

    def sample(cls, expand=True): 

        sample = cls(uuid='27e3153e-d5bf-4b7e-b517-fb518e17f34c', 

                     name='example', 

                     image_id='ubuntu', 

                     command='env', 

                     status='Running', 

                     bay_uuid="fff114da-3bfa-4a0f-a123-c0dffad9718e", 

                     created_at=datetime.datetime.utcnow(), 

                     updated_at=datetime.datetime.utcnow()) 

        return cls._convert_with_links(sample, 'http://localhost:9511', expand) 

 

 

class ContainerCollection(collection.Collection): 

    """API representation of a collection of containers.""" 

 

    containers = [Container] 

    """A list containing containers objects""" 

 

    def __init__(self, **kwargs): 

        self._type = 'containers' 

 

    @staticmethod 

    def convert_with_links(rpc_containers, limit, url=None, 

                           expand=False, **kwargs): 

        collection = ContainerCollection() 

        collection.containers = [Container.convert_with_links(p, expand) 

                            for p in rpc_containers] 

        collection.next = collection.get_next(limit, url=url, **kwargs) 

        return collection 

 

    @classmethod 

    def sample(cls): 

        sample = cls() 

        sample.containers = [Container.sample(expand=False)] 

        return sample 

 

 

class StartController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text) 

    def _default(self, container_ident): 

        if pecan.request.method != 'PUT': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

 

        LOG.debug('Calling conductor.container_start with %s' % 

                  container_uuid) 

        return pecan.request.rpcapi.container_start(container_uuid) 

 

 

class StopController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text) 

    def _default(self, container_ident): 

        if pecan.request.method != 'PUT': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

        LOG.debug('Calling conductor.container_stop with %s' % 

                  container_uuid) 

        return pecan.request.rpcapi.container_stop(container_uuid) 

 

 

class RebootController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text) 

    def _default(self, container_ident): 

        if pecan.request.method != 'PUT': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

        LOG.debug('Calling conductor.container_reboot with %s' % 

                  container_uuid) 

        return pecan.request.rpcapi.container_reboot(container_uuid) 

 

 

class PauseController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text) 

    def _default(self, container_ident): 

        if pecan.request.method != 'PUT': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

        LOG.debug('Calling conductor.container_pause with %s' % 

                  container_uuid) 

        return pecan.request.rpcapi.container_pause(container_uuid) 

 

 

class UnpauseController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text) 

    def _default(self, container_ident): 

        if pecan.request.method != 'PUT': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

        LOG.debug('Calling conductor.container_unpause with %s' % 

                  container_uuid) 

        return pecan.request.rpcapi.container_unpause(container_uuid) 

 

 

class LogsController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text) 

    def _default(self, container_ident): 

        if pecan.request.method != 'GET': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

        LOG.debug('Calling conductor.container_logs with %s' % 

        container_uuid) 

        return pecan.request.rpcapi.container_logs(container_uuid) 

 

 

class ExecuteController(object): 

    @wsme_pecan.wsexpose(types.uuid_or_name, wtypes.text, wtypes.text) 

    def _default(self, container_ident, command): 

241        if pecan.request.method != 'PUT': 

            pecan.abort(405, ('HTTP method %s is not allowed' 

                              % pecan.request.method)) 

        container_uuid = api_utils.get_rpc_resource('Container', 

                                                    container_ident).uuid 

        LOG.debug('Calling conductor.container_execute with %s command %s' 

                  % (container_uuid, command)) 

        return pecan.request.rpcapi.container_execute(container_uuid, command) 

 

 

class ContainersController(rest.RestController): 

    """REST controller for Containers.""" 

 

    def __init__(self): 

        super(ContainersController, self).__init__() 

 

    start = StartController() 

    stop = StopController() 

    reboot = RebootController() 

    pause = PauseController() 

    unpause = UnpauseController() 

    logs = LogsController() 

    execute = ExecuteController() 

 

    from_containers = False 

    """A flag to indicate if the requests to this controller are coming 

    from the top-level resource Containers.""" 

 

    _custom_actions = { 

        'detail': ['GET'], 

    } 

 

    def _get_containers_collection(self, marker, limit, 

                              sort_key, sort_dir, expand=False, 

                              resource_url=None): 

 

        limit = api_utils.validate_limit(limit) 

        sort_dir = api_utils.validate_sort_dir(sort_dir) 

 

        marker_obj = None 

281        if marker: 

            marker_obj = objects.Container.get_by_uuid(pecan.request.context, 

                                                  marker) 

 

        containers = objects.Container.list(pecan.request.context, limit, 

                                            marker_obj, sort_key=sort_key, 

                                            sort_dir=sort_dir) 

        containers = [pecan.request.rpcapi.container_show(c.uuid) 

                          for c in containers] 

 

        return ContainerCollection.convert_with_links(containers, limit, 

                                                url=resource_url, 

                                                expand=expand, 

                                                sort_key=sort_key, 

                                                sort_dir=sort_dir) 

 

    @wsme_pecan.wsexpose(ContainerCollection, types.uuid, 

                         types.uuid, int, wtypes.text, wtypes.text) 

    def get_all(self, container_uuid=None, marker=None, limit=None, 

                sort_key='id', sort_dir='asc'): 

        """Retrieve a list of containers. 

 

        :param marker: pagination marker for large data sets. 

        :param limit: maximum number of resources to return in a single result. 

        :param sort_key: column to sort results by. Default: id. 

        :param sort_dir: direction to sort. "asc" or "desc". Default: asc. 

        """ 

        return self._get_containers_collection(marker, limit, sort_key, 

                                               sort_dir) 

 

    @wsme_pecan.wsexpose(ContainerCollection, types.uuid, 

                         types.uuid, int, wtypes.text, wtypes.text) 

    def detail(self, container_uuid=None, marker=None, limit=None, 

                sort_key='id', sort_dir='asc'): 

        """Retrieve a list of containers with detail. 

 

        :param container_uuid: UUID of a container, to get only containers 

                               for that container. 

        :param marker: pagination marker for large data sets. 

        :param limit: maximum number of resources to return in a single result. 

        :param sort_key: column to sort results by. Default: id. 

        :param sort_dir: direction to sort. "asc" or "desc". Default: asc. 

        """ 

        parent = pecan.request.path.split('/')[:-1][-1] 

        if parent != "containers": 

            raise exception.HTTPNotFound 

 

        expand = True 

        resource_url = '/'.join(['containers', 'detail']) 

        return self._get_containers_collection(marker, limit, 

                                         sort_key, sort_dir, expand, 

                                         resource_url) 

 

    @wsme_pecan.wsexpose(Container, types.uuid_or_name) 

    def get_one(self, container_ident): 

        """Retrieve information about the given container. 

 

        :param container_ident: UUID or name of a container. 

        """ 

340        if self.from_containers: 

            raise exception.OperationNotPermitted 

 

        rpc_container = api_utils.get_rpc_resource('Container', 

                                                   container_ident) 

        res_container = pecan.request.rpcapi.container_show(rpc_container.uuid) 

        return Container.convert_with_links(res_container) 

 

    @wsme_pecan.wsexpose(Container, body=Container, status_code=201) 

    def post(self, container): 

        """Create a new container. 

 

        :param container: a container within the request body. 

        """ 

354        if self.from_containers: 

            raise exception.OperationNotPermitted 

 

        container_dict = container.as_dict() 

        context = pecan.request.context 

        auth_token = context.auth_token_info['token'] 

        container_dict['project_id'] = auth_token['project']['id'] 

        container_dict['user_id'] = auth_token['user']['id'] 

        new_container = objects.Container(context, **container_dict) 

        new_container.create() 

        res_container = pecan.request.rpcapi.container_create( 

                                    new_container.name, new_container.uuid, 

                                    new_container) 

 

        # Set the HTTP Location Header 

        pecan.response.location = link.build_url('containers', 

                                                 res_container.uuid) 

        return Container.convert_with_links(res_container) 

 

    @wsme.validate(types.uuid, [ContainerPatchType]) 

    @wsme_pecan.wsexpose(Container, types.uuid_or_name, 

                         body=[ContainerPatchType]) 

    def patch(self, container_ident, patch): 

        """Update an existing container. 

 

        :param container_ident: UUID or name of a container. 

        :param patch: a json PATCH document to apply to this container. 

        """ 

382        if self.from_containers: 

            raise exception.OperationNotPermitted 

 

        rpc_container = api_utils.get_rpc_resource('Container', 

                                                   container_ident) 

        try: 

            container_dict = rpc_container.as_dict() 

            container = Container(**api_utils.apply_jsonpatch( 

                container_dict, patch)) 

        except api_utils.JSONPATCH_EXCEPTIONS as e: 

            raise exception.PatchError(patch=patch, reason=e) 

 

        # Update only the fields that have changed 

        for field in objects.Container.fields: 

            try: 

                patch_val = getattr(container, field) 

            except AttributeError: 

                # Ignore fields that aren't exposed in the API 

                continue 

401            if patch_val == wtypes.Unset: 

                patch_val = None 

            if rpc_container[field] != patch_val: 

                rpc_container[field] = patch_val 

 

        rpc_container.save() 

        return Container.convert_with_links(rpc_container) 

 

    @wsme_pecan.wsexpose(None, types.uuid_or_name, status_code=204) 

    def delete(self, container_ident): 

        """Delete a container. 

 

        :param container_uuid: UUID of a container. 

        """ 

415        if self.from_containers: 

            raise exception.OperationNotPermitted 

 

        rpc_container = api_utils.get_rpc_resource('Container', 

                                                   container_ident) 

        pecan.request.rpcapi.container_delete(rpc_container.uuid) 

        rpc_container.destroy()