aws-cli/awscli/testutils.py at develop · tkellogg/aws-cli · GitHub

History

714 lines (599 loc) · 25.3 KB

Raw

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

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

# Licensed under the Apache License, Version 2.0 (the "License"). You

# may not use this file except in compliance with the License. A copy of

# the License is located at

# http://aws.amazon.com/apache2.0/

# or in the "license" file accompanying this file. This file 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.

"""Test utilities for the AWS CLI.

This module includes various classes/functions that help in writing

CLI unit/integration tests. This module should not be imported by

any module **except** for test code. This is included in the CLI

package so that code that is not part of the CLI can still take

advantage of all the testing utilities we provide.

"""

import os

import sys

import copy

import shutil

import time

import json

import random

import logging

import tempfile

import platform

import contextlib

import string

from pprint import pformat

from subprocess import Popen, PIPE

from awscli.compat import StringIO

try:

import mock

except ImportError as e:

# In the off chance something imports this module

# that's not suppose to, we should not stop the CLI

# by raising an ImportError. Now if anything actually

# *uses* this module that isn't suppose to, that's s

# different story.

mock = None

from awscli.compat import six

from botocore.hooks import HierarchicalEmitter

from botocore.session import Session

from botocore.exceptions import ClientError

import botocore.loaders

from botocore.vendored import requests

import awscli.clidriver

from awscli.plugin import load_plugins

from awscli.clidriver import CLIDriver

from awscli import EnvironmentVariables

# The unittest module got a significant overhaul

# in 2.7, so if we're in 2.6 we can use the backported

# version unittest2.

if sys.version_info[:2] == (2, 6):

import unittest2 as unittest

else:

import unittest

# In python 3, order matters when calling assertEqual to

# compare lists and dictionaries with lists. Therefore,

# assertItemsEqual needs to be used but it is renamed to

# assertCountEqual in python 3.

if six.PY2:

unittest.TestCase.assertCountEqual = unittest.TestCase.assertItemsEqual

_LOADER = botocore.loaders.Loader()

INTEG_LOG = logging.getLogger('awscli.tests.integration')

AWS_CMD = None

def create_clidriver():

driver = awscli.clidriver.create_clidriver()

session = driver.session

data_path = session.get_config_variable('data_path').split(os.pathsep)

if not data_path:

data_path = []

_LOADER.search_paths.extend(data_path)

session.register_component('data_loader', _LOADER)

return driver

def get_aws_cmd():

global AWS_CMD

import awscli

if AWS_CMD is None:

# Try <repo>/bin/aws

repo_root = os.path.dirname(os.path.abspath(awscli.__file__))

aws_cmd = os.path.join(repo_root, 'bin', 'aws')

if not os.path.isfile(aws_cmd):

aws_cmd = _search_path_for_cmd('aws')

if aws_cmd is None:

raise ValueError('Could not find "aws" executable. Either '

'make sure it is on your PATH, or you can '

'explicitly set this value using '

'"set_aws_cmd()"')

AWS_CMD = aws_cmd

return AWS_CMD

def _search_path_for_cmd(cmd_name):

for path in os.environ.get('PATH', '').split(os.pathsep):

full_cmd_path = os.path.join(path, cmd_name)

if os.path.isfile(full_cmd_path):

return full_cmd_path

return None

def set_aws_cmd(aws_cmd):

global AWS_CMD

AWS_CMD = aws_cmd

@contextlib.contextmanager

def temporary_file(mode):

"""This is a cross platform temporary file creation.

tempfile.NamedTemporary file on windows creates a secure temp file

that can't be read by other processes and can't be opened a second time.

For tests, we generally *want* them to be read multiple times.

The test fixture writes the temp file contents, the test reads the

temp file.

"""

temporary_directory = tempfile.mkdtemp()

basename = 'tmpfile-%s-%s' % (int(time.time()), random.randint(1, 1000))

full_filename = os.path.join(temporary_directory, basename)

open(full_filename, 'w').close()

try:

with open(full_filename, mode) as f:

yield f

finally:

shutil.rmtree(temporary_directory)

def create_bucket(session, name=None, region=None):

"""

Creates a bucket

:returns: the name of the bucket created

"""

if not region:

region = 'us-west-2'

client = session.create_client('s3', region_name=region)

if name:

bucket_name = name

else:

rand1 = ''.join(random.sample(string.ascii_lowercase + string.digits,

10))

bucket_name = 'awscli-s3test-' + str(rand1)

params = {'Bucket': bucket_name}

if region != 'us-east-1':

params['CreateBucketConfiguration'] = {'LocationConstraint': region}

client.create_bucket(**params)

return bucket_name

class BaseCLIDriverTest(unittest.TestCase):

"""Base unittest that use clidriver.

This will load all the default plugins as well so it

will simulate the behavior the user will see.

"""

def setUp(self):

self.environ = {

'AWS_DATA_PATH': os.environ['AWS_DATA_PATH'],

'AWS_DEFAULT_REGION': 'us-east-1',

'AWS_ACCESS_KEY_ID': 'access_key',

'AWS_SECRET_ACCESS_KEY': 'secret_key',

'AWS_CONFIG_FILE': '',

}

self.environ_patch = mock.patch('os.environ', self.environ)

self.environ_patch.start()

emitter = HierarchicalEmitter()

session = Session(EnvironmentVariables, emitter)

session.register_component('data_loader', _LOADER)

load_plugins({}, event_hooks=emitter)

driver = CLIDriver(session=session)

self.session = session

self.driver = driver

def tearDown(self):

self.environ_patch.stop()

class BaseAWSHelpOutputTest(BaseCLIDriverTest):

def setUp(self):

super(BaseAWSHelpOutputTest, self).setUp()

self.renderer_patch = mock.patch('awscli.help.get_renderer')

self.renderer_mock = self.renderer_patch.start()

self.renderer = CapturedRenderer()

self.renderer_mock.return_value = self.renderer

def tearDown(self):

super(BaseAWSHelpOutputTest, self).tearDown()

self.renderer_patch.stop()

def assert_contains(self, contains):

if contains not in self.renderer.rendered_contents:

self.fail("The expected contents:\n%s\nwere not in the "

"actual rendered contents:\n%s" % (

contains, self.renderer.rendered_contents))

def assert_contains_with_count(self, contains, count):

r_count = self.renderer.rendered_contents.count(contains)

if r_count != count:

self.fail("The expected contents:\n%s\n, with the "

"count:\n%d\nwere not in the actual rendered "

" contents:\n%s\nwith count:\n%d" % (

contains, count, self.renderer.rendered_contents, r_count))

def assert_not_contains(self, contents):

if contents in self.renderer.rendered_contents:

self.fail("The contents:\n%s\nwere not suppose to be in the "

"actual rendered contents:\n%s" % (

contents, self.renderer.rendered_contents))

def assert_text_order(self, *args, **kwargs):

# First we need to find where the SYNOPSIS section starts.

starting_from = kwargs.pop('starting_from')

args = list(args)

contents = self.renderer.rendered_contents

self.assertIn(starting_from, contents)

start_index = contents.find(starting_from)

arg_indices = [contents.find(arg, start_index) for arg in args]

previous = arg_indices[0]

for i, index in enumerate(arg_indices[1:], 1):

if index == -1:

self.fail('The string %r was not found in the contents: %s'

% (args[index], contents))

if index < previous:

self.fail('The string %r came before %r, but was suppose to come '

'after it.\n%s' % (args[i], args[i - 1], contents))

previous = index

class CapturedRenderer(object):

def __init__(self):

self.rendered_contents = ''

def render(self, contents):

self.rendered_contents = contents.decode('utf-8')

class CapturedOutput(object):

def __init__(self, stdout, stderr):

self.stdout = stdout

self.stderr = stderr

@contextlib.contextmanager

def capture_output():

stderr = six.StringIO()

stdout = six.StringIO()

with mock.patch('sys.stderr', stderr):

with mock.patch('sys.stdout', stdout):

yield CapturedOutput(stdout, stderr)

class BaseAWSCommandParamsTest(unittest.TestCase):

maxDiff = None

def setUp(self):

self.last_params = {}

# awscli/__init__.py injects AWS_DATA_PATH at import time

# so that we can find cli.json. This might be fixed in the

# future, but for now we just grab that value out of the real

# os.environ so the patched os.environ has this data and

# the CLI works.

self.environ = {

'AWS_DATA_PATH': os.environ['AWS_DATA_PATH'],

'AWS_DEFAULT_REGION': 'us-east-1',

'AWS_ACCESS_KEY_ID': 'access_key',

'AWS_SECRET_ACCESS_KEY': 'secret_key',

}

self.environ_patch = mock.patch('os.environ', self.environ)

self.environ_patch.start()

self.http_response = requests.models.Response()

self.http_response.status_code = 200

self.parsed_response = {}

self.make_request_patch = mock.patch('botocore.endpoint.Endpoint.make_request')

self.make_request_is_patched = False

self.operations_called = []

self.parsed_responses = None

self.driver = create_clidriver()

def tearDown(self):

# This clears all the previous registrations.

self.environ_patch.stop()

if self.make_request_is_patched:

self.make_request_patch.stop()

def before_call(self, params, **kwargs):

self._store_params(params)

def _store_params(self, params):

self.last_request_dict = params

self.last_params = params['body']

def patch_make_request(self):

make_request_patch = self.make_request_patch.start()

if self.parsed_responses is not None:

make_request_patch.side_effect = lambda *args, **kwargs: \

(self.http_response, self.parsed_responses.pop(0))

else:

make_request_patch.return_value = (self.http_response, self.parsed_response)

self.make_request_is_patched = True

def assert_params_for_cmd(self, cmd, params=None, expected_rc=0,

stderr_contains=None, ignore_params=None):

stdout, stderr, rc = self.run_cmd(cmd, expected_rc)

if stderr_contains is not None:

self.assertIn(stderr_contains, stderr)

if params is not None:

# The last kwargs of Operation.call() in botocore.

last_kwargs = copy.copy(self.last_kwargs)

if ignore_params is not None:

for key in ignore_params:

try:

del last_kwargs[key]

except KeyError:

pass

if params != last_kwargs:

self.fail("Actual params did not match expected params.\n"

"Expected:\n\n"

"%s\n"

"Actual:\n\n%s\n" % (

pformat(params), pformat(last_kwargs)))

return stdout, stderr, rc

def before_parameter_build(self, params, model, **kwargs):

self.last_kwargs = params

self.operations_called.append((model, params))

def run_cmd(self, cmd, expected_rc=0):

logging.debug("Calling cmd: %s", cmd)

self.patch_make_request()

self.driver.session.register('before-call', self.before_call)

self.driver.session.register('before-parameter-build',

self.before_parameter_build)

if not isinstance(cmd, list):

cmdlist = cmd.split()

else:

cmdlist = cmd

with capture_output() as captured:

try:

rc = self.driver.main(cmdlist)

except SystemExit as e:

# We need to catch SystemExit so that we

# can get a proper rc and still present the

# stdout/stderr to the test runner so we can

# figure out what went wrong.

rc = e.code

stderr = captured.stderr.getvalue()

stdout = captured.stdout.getvalue()

self.assertEqual(

rc, expected_rc,

"Unexpected rc (expected: %s, actual: %s) for command: %s\n"

"stdout:\n%sstderr:\n%s" % (

expected_rc, rc, cmd, stdout, stderr))

return stdout, stderr, rc

class BaseAWSPreviewCommandParamsTest(BaseAWSCommandParamsTest):

def setUp(self):

self.preview_patch = mock.patch(

'awscli.customizations.preview.mark_as_preview')

self.preview_patch.start()

super(BaseAWSPreviewCommandParamsTest, self).setUp()

def tearDown(self):

self.preview_patch.stop()

super(BaseAWSPreviewCommandParamsTest, self).tearDown()

class FileCreator(object):

def __init__(self):

self.rootdir = tempfile.mkdtemp()

def remove_all(self):

shutil.rmtree(self.rootdir)

def create_file(self, filename, contents, mtime=None, mode='w'):

"""Creates a file in a tmpdir

``filename`` should be a relative path, e.g. "foo/bar/baz.txt"

It will be translated into a full path in a tmp dir.

If the ``mtime`` argument is provided, then the file's

mtime will be set to the provided value (must be an epoch time).

Otherwise the mtime is left untouched.

``mode`` is the mode the file should be opened either as ``w`` or

`wb``.

Returns the full path to the file.

"""

full_path = os.path.join(self.rootdir, filename)

if not os.path.isdir(os.path.dirname(full_path)):

os.makedirs(os.path.dirname(full_path))

with open(full_path, mode) as f:

f.write(contents)

current_time = os.path.getmtime(full_path)

# Subtract a few years off the last modification date.

os.utime(full_path, (current_time, current_time - 100000000))

if mtime is not None:

os.utime(full_path, (mtime, mtime))

return full_path

def append_file(self, filename, contents):

"""Append contents to a file

``filename`` should be a relative path, e.g. "foo/bar/baz.txt"

It will be translated into a full path in a tmp dir.

Returns the full path to the file.

"""

full_path = os.path.join(self.rootdir, filename)

if not os.path.isdir(os.path.dirname(full_path)):

os.makedirs(os.path.dirname(full_path))

with open(full_path, 'a') as f:

f.write(contents)

return full_path

def full_path(self, filename):

"""Translate relative path to full path in temp dir.

f.full_path('foo/bar.txt') -> /tmp/asdfasd/foo/bar.txt

"""

return os.path.join(self.rootdir, filename)

class ProcessTerminatedError(Exception):

pass

class Result(object):

def __init__(self, rc, stdout, stderr, memory_usage=None):

self.rc = rc

self.stdout = stdout

self.stderr = stderr

INTEG_LOG.debug("rc: %s", rc)

INTEG_LOG.debug("stdout: %s", stdout)

INTEG_LOG.debug("stderr: %s", stderr)

if memory_usage is None:

memory_usage = []

self.memory_usage = memory_usage

@property

def json(self):

return json.loads(self.stdout)

def _escape_quotes(command):

# For windows we have different rules for escaping.

# First, double quotes must be escaped.

command = command.replace('"', '\\"')

# Second, single quotes do nothing, to quote a value we need

# to use double quotes.

command = command.replace("'", '"')

return command

def aws(command, collect_memory=False, env_vars=None,

wait_for_finish=True, input_data=None, input_file=None):

"""Run an aws command.

This help function abstracts the differences of running the "aws"

command on different platforms.

If collect_memory is ``True`` the the Result object will have a list

of memory usage taken at 2 second intervals. The memory usage

will be in bytes.

If env_vars is None, this will set the environment variables

to be used by the aws process.

If wait_for_finish is False, then the Process object is returned

to the caller. It is then the caller's responsibility to ensure

proper cleanup. This can be useful if you want to test timeout's

or how the CLI responds to various signals.

:type input_data: string

:param input_data: This string will be communicated to the process through

the stdin of the process. It essentially allows the user to

avoid having to use a file handle to pass information to the process.

Note that this string is not passed on creation of the process, but

rather communicated to the process.

:type input_file: a file handle

:param input_file: This is a file handle that will act as the

the stdin of the process immediately on creation. Essentially

any data written to the file will be read from stdin of the

process. This is needed if you plan to stream data into stdin while

collecting memory.

"""

if platform.system() == 'Windows':

command = _escape_quotes(command)

if 'AWS_TEST_COMMAND' in os.environ:

aws_command = os.environ['AWS_TEST_COMMAND']

else:

aws_command = 'python %s' % get_aws_cmd()

full_command = '%s %s' % (aws_command, command)

stdout_encoding = get_stdout_encoding()

if isinstance(full_command, six.text_type) and not six.PY3:

full_command = full_command.encode(stdout_encoding)

INTEG_LOG.debug("Running command: %s", full_command)

env = os.environ.copy()

env['AWS_DEFAULT_REGION'] = "us-east-1"

if env_vars is not None:

env = env_vars

if input_file is None:

input_file = PIPE

process = Popen(full_command, stdout=PIPE, stderr=PIPE, stdin=input_file,

shell=True, env=env)

if not wait_for_finish:

return process

memory = None

if not collect_memory:

kwargs = {}

if input_data:

kwargs = {'input': input_data}

stdout, stderr = process.communicate(**kwargs)

else:

stdout, stderr, memory = _wait_and_collect_mem(process)

return Result(process.returncode,

stdout.decode(stdout_encoding),

stderr.decode(stdout_encoding),

memory)

def get_stdout_encoding():

encoding = getattr(sys.__stdout__, 'encoding', None)

if encoding is None:

encoding = 'utf-8'

return encoding

def _wait_and_collect_mem(process):

# We only know how to collect memory on mac/linux.

if platform.system() == 'Darwin':

get_memory = _get_memory_with_ps

elif platform.system() == 'Linux':

get_memory = _get_memory_with_ps

else:

raise ValueError(

"Can't collect memory for process on platform %s." %

platform.system())

memory = []

while process.poll() is None:

try:

current = get_memory(process.pid)

except ProcessTerminatedError:

# It's possible the process terminated between .poll()

# and get_memory().

break

memory.append(current)

stdout, stderr = process.communicate()

return stdout, stderr, memory

def _get_memory_with_ps(pid):

# It's probably possible to do with proc_pidinfo and ctypes on a Mac,

# but we'll do it the easy way with parsing ps output.

command_list = 'ps u -p'.split()

command_list.append(str(pid))

p = Popen(command_list, stdout=PIPE)

stdout = p.communicate()[0]

if not p.returncode == 0:

raise ProcessTerminatedError(str(pid))

else:

# Get the RSS from output that looks like this:

# USER PID %CPU %MEM VSZ RSS TT STAT STARTED TIME COMMAND

# user 47102 0.0 0.1 2437000 4496 s002 S+ 7:04PM 0:00.12 python2.6

return int(stdout.splitlines()[1].split()[5]) * 1024

class BaseS3CLICommand(unittest.TestCase):

"""Base class for aws s3 command.

This contains convenience functions to make writing these tests easier

and more streamlined.

"""

def setUp(self):

self.files = FileCreator()

self.session = botocore.session.get_session()

self.regions = {}

self.region = 'us-west-2'

self.client = self.session.create_client('s3', region_name=self.region)

self.extra_setup()

def extra_setup(self):

# Subclasses can use this to define extra setup steps.

pass

def tearDown(self):

self.files.remove_all()

self.extra_teardown()

def extra_teardown(self):

# Subclasses can use this to define extra teardown steps.

pass

def assert_key_contents_equal(self, bucket, key, expected_contents):

if isinstance(expected_contents, six.BytesIO):

expected_contents = expected_contents.getvalue().decode('utf-8')

actual_contents = self.get_key_contents(bucket, key)

# The contents can be huge so we try to give helpful error messages

# without necessarily printing the actual contents.

self.assertEqual(len(actual_contents), len(expected_contents))

if actual_contents != expected_contents:

self.fail("Contents for %s/%s do not match (but they "

"have the same length)" % (bucket, key))

def create_bucket(self, name=None, region=None):

if not region:

region = self.region

bucket_name = create_bucket(self.session, name, region)

self.regions[bucket_name] = region

self.addCleanup(self.delete_bucket, bucket_name)

return bucket_name

def put_object(self, bucket_name, key_name, contents='', extra_args=None):

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

call_args = {

'Bucket': bucket_name,

'Key': key_name, 'Body': contents

}

if extra_args is not None:

call_args.update(extra_args)

response = client.put_object(**call_args)

self.addCleanup(self.delete_key, bucket_name, key_name)

def delete_bucket(self, bucket_name):

self.remove_all_objects(bucket_name)

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

response = client.delete_bucket(Bucket=bucket_name)

del self.regions[bucket_name]

def remove_all_objects(self, bucket_name):

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

paginator = client.get_paginator('list_objects')

pages = paginator.paginate(Bucket=bucket_name)

key_names = []

for page in pages:

key_names += [obj['Key'] for obj in page.get('Contents', [])]

for key_name in key_names:

self.delete_key(bucket_name, key_name)

def delete_key(self, bucket_name, key_name):

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

response = client.delete_object(Bucket=bucket_name, Key=key_name)

def get_key_contents(self, bucket_name, key_name):

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

response = client.get_object(Bucket=bucket_name, Key=key_name)

return response['Body'].read().decode('utf-8')

def key_exists(self, bucket_name, key_name):

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

try:

client.head_object(Bucket=bucket_name, Key=key_name)

return True

except ClientError:

return False

def list_buckets(self):

response = self.client.list_buckets()

return response['Buckets']

def content_type_for_key(self, bucket_name, key_name):

parsed = self.head_object(bucket_name, key_name)

return parsed['ContentType']

def head_object(self, bucket_name, key_name):

client = self.session.create_client(

's3', region_name=self.regions[bucket_name])

response = client.head_object(Bucket=bucket_name, Key=key_name)

return response

def assert_no_errors(self, p):

self.assertEqual(

p.rc, 0,

"Non zero rc (%s) received: %s" % (p.rc, p.stdout + p.stderr))

self.assertNotIn("Error:", p.stderr)

self.assertNotIn("failed:", p.stderr)

self.assertNotIn("client error", p.stderr)

self.assertNotIn("server error", p.stderr)

class StringIOWithFileNo(StringIO):

def fileno(self):

return 0

aws-cli/awscli/testutils.py at develop · tkellogg/aws-cli · GitHub

Expand file tree

Breadcrumbs

testutils.py

Latest commit

History

Breadcrumbs

testutils.py

File metadata and controls