FilesExpand file tree

 3.16.0

/

shell.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

213 lines (175 loc) · 8 KB

 3.16.0

/

shell.py

Copy path

Top

File metadata and controls

• Code
• Blame

213 lines (175 loc) · 8 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

# Copyright 2012-2013 OpenStack Foundation

# Copyright 2015 Dean Troyer

#

# 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.

#

"""Command-line interface to the OpenStack APIs"""

import locale

import sys

from osc_lib.api import auth

from osc_lib import shell

import six

import openstackclient

from openstackclient.common import client_config as cloud_config

from openstackclient.common import clientmanager

from openstackclient.common import commandmanager

DEFAULT_DOMAIN = 'default'

class OpenStackShell(shell.OpenStackShell):

def __init__(self):

super(OpenStackShell, self).__init__(

description=__doc__.strip(),

version=openstackclient.__version__,

command_manager=commandmanager.CommandManager('openstack.cli'),

deferred_help=True)

self.api_version = {}

# Assume TLS host certificate verification is enabled

self.verify = True

def build_option_parser(self, description, version):

parser = super(OpenStackShell, self).build_option_parser(

description,

version)

parser = clientmanager.build_plugin_option_parser(parser)

parser = auth.build_auth_plugins_option_parser(parser)

return parser

def _final_defaults(self):

super(OpenStackShell, self)._final_defaults()

# Set the default plugin to token_endpoint if url and token are given

if (self.options.url and self.options.token):

# Use service token authentication

self._auth_type = 'token_endpoint'

else:

self._auth_type = 'password'

def _load_plugins(self):

"""Load plugins via stevedore

osc-lib has no opinion on what plugins should be loaded

"""

# Loop through extensions to get API versions

for mod in clientmanager.PLUGIN_MODULES:

default_version = getattr(mod, 'DEFAULT_API_VERSION', None)

# Only replace the first instance of "os", some service names will

# have "os" in their name, like: "antiddos"

option = mod.API_VERSION_OPTION.replace('os_', '', 1)

version_opt = str(self.cloud.config.get(option, default_version))

if version_opt:

api = mod.API_NAME

self.api_version[api] = version_opt

# Add a plugin interface to let the module validate the version

# requested by the user

skip_old_check = False

mod_check_api_version = getattr(mod, 'check_api_version', None)

if mod_check_api_version:

# this throws an exception if invalid

skip_old_check = mod_check_api_version(version_opt)

mod_versions = getattr(mod, 'API_VERSIONS', None)

if not skip_old_check and mod_versions:

if version_opt not in mod_versions:

sorted_versions = sorted(

mod.API_VERSIONS.keys(),

key=lambda s: list(map(int, s.split('.'))))

self.log.warning(

"%s version %s is not in supported versions: %s"

% (api, version_opt, ', '.join(sorted_versions)))

# Command groups deal only with major versions

version = '.v' + version_opt.replace('.', '_').split('_')[0]

cmd_group = 'openstack.' + api.replace('-', '_') + version

self.command_manager.add_command_group(cmd_group)

self.log.debug(

'%(name)s API version %(version)s, cmd group %(group)s',

{'name': api, 'version': version_opt, 'group': cmd_group}

)

def _load_commands(self):

"""Load commands via cliff/stevedore

osc-lib has no opinion on what commands should be loaded

"""

# Commands that span multiple APIs

self.command_manager.add_command_group(

'openstack.common')

# This is the naive extension implementation referred to in

# blueprint 'client-extensions'

# Extension modules can register their commands in an

# 'openstack.extension' entry point group:

# entry_points={

# 'openstack.extension': [

# 'list_repo=qaz.github.repo:ListRepo',

# 'show_repo=qaz.github.repo:ShowRepo',

# ],

# }

self.command_manager.add_command_group(

'openstack.extension')

def initialize_app(self, argv):

super(OpenStackShell, self).initialize_app(argv)

# Argument precedence is really broken in multiple places

# so we're just going to fix it here until o-c-c and osc-lib

# get sorted out.

# TODO(dtroyer): remove when os-client-config and osc-lib are fixed

# First, throw away what has already been done with o-c-c and

# use our own.

try:

self.cloud_config = cloud_config.OSC_Config(

override_defaults={

'interface': None,

'auth_type': self._auth_type,

},

)

except (IOError, OSError):

self.log.critical("Could not read clouds.yaml configuration file")

self.print_help_if_requested()

raise

if not self.options.debug:

self.options.debug = None

# NOTE(dtroyer): Need to do this with validate=False to defer the

# auth plugin handling to ClientManager.setup_auth()

self.cloud = self.cloud_config.get_one_cloud(

cloud=self.options.cloud,

argparse=self.options,

validate=False,

)

# Then, re-create the client_manager with the correct arguments

self.client_manager = clientmanager.ClientManager(

cli_options=self.cloud,

api_version=self.api_version,

pw_func=shell.prompt_for_password,

)

def prepare_to_run_command(self, cmd):

"""Set up auth and API versions"""

# TODO(dtroyer): Move this to osc-lib, remove entire method when 1.4.0

# release is minimum version is in global-requirements

# NOTE(dtroyer): If auth is not required for a command, skip

# get_one_Cloud()'s validation to avoid loading plugins

validate = cmd.auth_required

# Force skipping auth for commands that do not need it

# NOTE(dtroyer): This is here because ClientManager does not have

# visibility into the Command object to get

# auth_required. It needs to move into osc-lib

self.client_manager._auth_required = cmd.auth_required

# Validate auth options

self.cloud = self.cloud_config.get_one_cloud(

cloud=self.options.cloud,

argparse=self.options,

validate=validate,

)

# Push the updated args into ClientManager

self.client_manager._cli_options = self.cloud

return super(OpenStackShell, self).prepare_to_run_command(cmd)

def main(argv=None):

if argv is None:

argv = sys.argv[1:]

if six.PY2:

# Emulate Py3, decode argv into Unicode based on locale so that

# commands always see arguments as text instead of binary data

encoding = locale.getpreferredencoding()

if encoding:

argv = map(lambda arg: arg.decode(encoding), argv)

return OpenStackShell().run(argv)

if __name__ == "__main__":

sys.exit(main())