Browse Source

network refactor for Pike and Chef 13

- implemented foodcritic and cookstyle corrections
- deprecated node.foo.bar method access for node['foo']['bar'] bracket syntax
- deduplicated resource calls for identity registration
- moved dpkg overrides to common cookbook for DRY

Implements blueprint modern-chef

Depends-On: I143e0ed0a2bdd76269fc0c402052696426d96d81
Change-Id: Ib268737d2f5c3196061d89202d806c3af1c54e72
Samuel Cassiba 1 year ago
parent
commit
77e2e705c3

+ 11
- 8
Berksfile View File

@@ -1,11 +1,14 @@
1
-source "https://supermarket.chef.io"
1
+source 'https://supermarket.chef.io'
2 2
 
3
-metadata
3
+%w(common identity).each do |cookbook|
4
+  if Dir.exist?("../cookbook-openstack-#{cookbook}")
5
+    cookbook "openstack-#{cookbook}", path: "../cookbook-openstack-#{cookbook}"
6
+  else
7
+    cookbook "openstack-#{cookbook}", github: "openstack/cookbook-openstack-#{cookbook}"
8
+  end
9
+end
4 10
 
5
-cookbook 'openstack-identity',
6
-  github: 'openstack/cookbook-openstack-identity'
7
-cookbook 'openstack-common',
8
-  github: 'openstack/cookbook-openstack-common'
9
-cookbook "openstackclient",
10
-  github: "cloudbau/cookbook-openstackclient"
11
+cookbook 'openstackclient',
12
+  github: 'cloudbau/cookbook-openstackclient'
11 13
 
14
+metadata

+ 176
- 0
LICENSE View File

@@ -0,0 +1,176 @@
1
+
2
+                                 Apache License
3
+                           Version 2.0, January 2004
4
+                        http://www.apache.org/licenses/
5
+
6
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+   1. Definitions.
9
+
10
+      "License" shall mean the terms and conditions for use, reproduction,
11
+      and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+      "Licensor" shall mean the copyright owner or entity authorized by
14
+      the copyright owner that is granting the License.
15
+
16
+      "Legal Entity" shall mean the union of the acting entity and all
17
+      other entities that control, are controlled by, or are under common
18
+      control with that entity. For the purposes of this definition,
19
+      "control" means (i) the power, direct or indirect, to cause the
20
+      direction or management of such entity, whether by contract or
21
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+      outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+      "You" (or "Your") shall mean an individual or Legal Entity
25
+      exercising permissions granted by this License.
26
+
27
+      "Source" form shall mean the preferred form for making modifications,
28
+      including but not limited to software source code, documentation
29
+      source, and configuration files.
30
+
31
+      "Object" form shall mean any form resulting from mechanical
32
+      transformation or translation of a Source form, including but
33
+      not limited to compiled object code, generated documentation,
34
+      and conversions to other media types.
35
+
36
+      "Work" shall mean the work of authorship, whether in Source or
37
+      Object form, made available under the License, as indicated by a
38
+      copyright notice that is included in or attached to the work
39
+      (an example is provided in the Appendix below).
40
+
41
+      "Derivative Works" shall mean any work, whether in Source or Object
42
+      form, that is based on (or derived from) the Work and for which the
43
+      editorial revisions, annotations, elaborations, or other modifications
44
+      represent, as a whole, an original work of authorship. For the purposes
45
+      of this License, Derivative Works shall not include works that remain
46
+      separable from, or merely link (or bind by name) to the interfaces of,
47
+      the Work and Derivative Works thereof.
48
+
49
+      "Contribution" shall mean any work of authorship, including
50
+      the original version of the Work and any modifications or additions
51
+      to that Work or Derivative Works thereof, that is intentionally
52
+      submitted to Licensor for inclusion in the Work by the copyright owner
53
+      or by an individual or Legal Entity authorized to submit on behalf of
54
+      the copyright owner. For the purposes of this definition, "submitted"
55
+      means any form of electronic, verbal, or written communication sent
56
+      to the Licensor or its representatives, including but not limited to
57
+      communication on electronic mailing lists, source code control systems,
58
+      and issue tracking systems that are managed by, or on behalf of, the
59
+      Licensor for the purpose of discussing and improving the Work, but
60
+      excluding communication that is conspicuously marked or otherwise
61
+      designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+      "Contributor" shall mean Licensor and any individual or Legal Entity
64
+      on behalf of whom a Contribution has been received by Licensor and
65
+      subsequently incorporated within the Work.
66
+
67
+   2. Grant of Copyright License. Subject to the terms and conditions of
68
+      this License, each Contributor hereby grants to You a perpetual,
69
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+      copyright license to reproduce, prepare Derivative Works of,
71
+      publicly display, publicly perform, sublicense, and distribute the
72
+      Work and such Derivative Works in Source or Object form.
73
+
74
+   3. Grant of Patent License. Subject to the terms and conditions of
75
+      this License, each Contributor hereby grants to You a perpetual,
76
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+      (except as stated in this section) patent license to make, have made,
78
+      use, offer to sell, sell, import, and otherwise transfer the Work,
79
+      where such license applies only to those patent claims licensable
80
+      by such Contributor that are necessarily infringed by their
81
+      Contribution(s) alone or by combination of their Contribution(s)
82
+      with the Work to which such Contribution(s) was submitted. If You
83
+      institute patent litigation against any entity (including a
84
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+      or a Contribution incorporated within the Work constitutes direct
86
+      or contributory patent infringement, then any patent licenses
87
+      granted to You under this License for that Work shall terminate
88
+      as of the date such litigation is filed.
89
+
90
+   4. Redistribution. You may reproduce and distribute copies of the
91
+      Work or Derivative Works thereof in any medium, with or without
92
+      modifications, and in Source or Object form, provided that You
93
+      meet the following conditions:
94
+
95
+      (a) You must give any other recipients of the Work or
96
+          Derivative Works a copy of this License; and
97
+
98
+      (b) You must cause any modified files to carry prominent notices
99
+          stating that You changed the files; and
100
+
101
+      (c) You must retain, in the Source form of any Derivative Works
102
+          that You distribute, all copyright, patent, trademark, and
103
+          attribution notices from the Source form of the Work,
104
+          excluding those notices that do not pertain to any part of
105
+          the Derivative Works; and
106
+
107
+      (d) If the Work includes a "NOTICE" text file as part of its
108
+          distribution, then any Derivative Works that You distribute must
109
+          include a readable copy of the attribution notices contained
110
+          within such NOTICE file, excluding those notices that do not
111
+          pertain to any part of the Derivative Works, in at least one
112
+          of the following places: within a NOTICE text file distributed
113
+          as part of the Derivative Works; within the Source form or
114
+          documentation, if provided along with the Derivative Works; or,
115
+          within a display generated by the Derivative Works, if and
116
+          wherever such third-party notices normally appear. The contents
117
+          of the NOTICE file are for informational purposes only and
118
+          do not modify the License. You may add Your own attribution
119
+          notices within Derivative Works that You distribute, alongside
120
+          or as an addendum to the NOTICE text from the Work, provided
121
+          that such additional attribution notices cannot be construed
122
+          as modifying the License.
123
+
124
+      You may add Your own copyright statement to Your modifications and
125
+      may provide additional or different license terms and conditions
126
+      for use, reproduction, or distribution of Your modifications, or
127
+      for any such Derivative Works as a whole, provided Your use,
128
+      reproduction, and distribution of the Work otherwise complies with
129
+      the conditions stated in this License.
130
+
131
+   5. Submission of Contributions. Unless You explicitly state otherwise,
132
+      any Contribution intentionally submitted for inclusion in the Work
133
+      by You to the Licensor shall be under the terms and conditions of
134
+      this License, without any additional terms or conditions.
135
+      Notwithstanding the above, nothing herein shall supersede or modify
136
+      the terms of any separate license agreement you may have executed
137
+      with Licensor regarding such Contributions.
138
+
139
+   6. Trademarks. This License does not grant permission to use the trade
140
+      names, trademarks, service marks, or product names of the Licensor,
141
+      except as required for reasonable and customary use in describing the
142
+      origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+   7. Disclaimer of Warranty. Unless required by applicable law or
145
+      agreed to in writing, Licensor provides the Work (and each
146
+      Contributor provides its Contributions) on an "AS IS" BASIS,
147
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+      implied, including, without limitation, any warranties or conditions
149
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+      PARTICULAR PURPOSE. You are solely responsible for determining the
151
+      appropriateness of using or redistributing the Work and assume any
152
+      risks associated with Your exercise of permissions under this License.
153
+
154
+   8. Limitation of Liability. In no event and under no legal theory,
155
+      whether in tort (including negligence), contract, or otherwise,
156
+      unless required by applicable law (such as deliberate and grossly
157
+      negligent acts) or agreed to in writing, shall any Contributor be
158
+      liable to You for damages, including any direct, indirect, special,
159
+      incidental, or consequential damages of any character arising as a
160
+      result of this License or out of the use or inability to use the
161
+      Work (including but not limited to damages for loss of goodwill,
162
+      work stoppage, computer failure or malfunction, or any and all
163
+      other commercial damages or losses), even if such Contributor
164
+      has been advised of the possibility of such damages.
165
+
166
+   9. Accepting Warranty or Additional Liability. While redistributing
167
+      the Work or Derivative Works thereof, You may choose to offer,
168
+      and charge a fee for, acceptance of support, warranty, indemnity,
169
+      or other liability obligations and/or rights consistent with this
170
+      License. However, in accepting such obligations, You may act only
171
+      on Your own behalf and on Your sole responsibility, not on behalf
172
+      of any other Contributor, and only if You agree to indemnify,
173
+      defend, and hold each Contributor harmless for any liability
174
+      incurred by, or claims asserted against, such Contributor by reason
175
+      of your accepting any such warranty or additional liability.
176
+

+ 15
- 16
Rakefile View File

@@ -1,40 +1,39 @@
1
-task default: ["test"]
1
+task default: ['test']
2 2
 
3
-task :test => [:syntax, :lint, :unit]
3
+task test: [:syntax, :lint, :unit]
4 4
 
5
-desc "Vendor the cookbooks in the Berksfile"
5
+desc 'Vendor the cookbooks in the Berksfile'
6 6
 task :berks_prep do
7
-  sh %{chef exec berks vendor}
7
+  sh %(chef exec berks vendor)
8 8
 end
9 9
 
10
-desc "Run FoodCritic (syntax) tests"
10
+desc 'Run FoodCritic (syntax) tests'
11 11
 task :syntax do
12
-  sh %{chef exec foodcritic --exclude spec -f any .}
12
+  sh %(chef exec foodcritic --exclude spec -f any .)
13 13
 end
14 14
 
15
-desc "Run RuboCop (lint) tests"
15
+desc 'Run RuboCop (lint) tests'
16 16
 task :lint do
17
-  sh %{chef exec cookstyle}
17
+  sh %(chef exec cookstyle)
18 18
 end
19 19
 
20
-desc "Run RSpec (unit) tests"
21
-task :unit => :berks_prep do
22
-  sh %{chef exec rspec --format documentation}
20
+desc 'Run RSpec (unit) tests'
21
+task unit: :berks_prep do
22
+  sh %(chef exec rspec --format documentation)
23 23
 end
24 24
 
25
-desc "Remove the berks-cookbooks directory and the Berksfile.lock"
25
+desc 'Remove the berks-cookbooks directory and the Berksfile.lock'
26 26
 task :clean do
27 27
   rm_rf [
28 28
     'berks-cookbooks',
29
-    'Berksfile.lock'
29
+    'Berksfile.lock',
30 30
   ]
31 31
 end
32 32
 
33
-desc "All-in-One Neutron build Infra using Common task"
33
+desc 'All-in-One Neutron build Infra using Common task'
34 34
 task :integration do
35 35
   # Use the common integration task
36 36
   sh %(wget -nv -t 3 -O Rakefile-Common https://raw.githubusercontent.com/openstack/cookbook-openstack-common/master/Rakefile)
37 37
   load './Rakefile-Common'
38
-  Rake::Task["common_integration"].invoke
38
+  Rake::Task['common_integration'].invoke
39 39
 end
40
-

+ 1
- 1
attributes/default.rb View File

@@ -293,6 +293,6 @@ default['openstack']['network']['platform'].tap do |platform|
293 293
     platform['neutron_openvswitch_agent_service'] =
294 294
       'neutron-openvswitch-agent'
295 295
     platform['package_overrides'] =
296
-      "-o Dpkg::Options::='--force-confold' -o Dpkg::Options::='--force-confdef'"
296
+      ''
297 297
   end
298 298
 end

+ 1
- 1
metadata.rb View File

@@ -1,7 +1,7 @@
1 1
 name             'openstack-network'
2 2
 maintainer       'openstack-chef'
3 3
 maintainer_email 'openstack-dev@lists.openstack.org'
4
-license          'Apache 2.0'
4
+license          'Apache-2.0'
5 5
 description      'Installs and configures the OpenStack Network API Service and various agents and plugins'
6 6
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
7 7
 version          '16.0.0'

+ 2
- 2
recipes/default.rb View File

@@ -20,7 +20,7 @@
20 20
 # limitations under the License.
21 21
 #
22 22
 
23
-require 'uri'
23
+require 'addressable'
24 24
 
25 25
 # Make Openstack object available in Chef::Recipe
26 26
 class ::Chef::Recipe
@@ -101,7 +101,7 @@ node.default['openstack']['network']['conf'].tap do |conf|
101 101
     conf['DEFAULT']['log_config'] = '/etc/openstack/logging.conf'
102 102
   end
103 103
   conf['DEFAULT']['bind_host'] = bind_service_address
104
-  conf['DEFAULT']['bind_port'] = bind_service.port
104
+  conf['DEFAULT']['bind_port'] = bind_service['port']
105 105
   conf['nova']['auth_url'] = nova_auth_url if nova_auth_url
106 106
   conf['keystone_authtoken']['auth_url'] = auth_url
107 107
 end

+ 2
- 8
recipes/identity_registration.rb View File

@@ -85,16 +85,10 @@ end
85 85
 
86 86
 # Register Service User
87 87
 openstack_user service_user do
88
+  role_name service_role
88 89
   project_name service_tenant_name
89 90
   domain_name service_domain_name
90 91
   password service_pass
91 92
   connection_params connection_params
92
-end
93
-
94
-## Grant Service role to Service User for Service Tenant ##
95
-openstack_user service_user do
96
-  role_name service_role
97
-  project_name service_tenant_name
98
-  connection_params connection_params
99
-  action :grant_role
93
+  action [:create, :grant_role]
100 94
 end

+ 1
- 1
recipes/ml2_openvswitch.rb View File

@@ -18,7 +18,7 @@
18 18
 # limitations under the License.
19 19
 #
20 20
 
21
-require 'uri'
21
+require 'addressable'
22 22
 
23 23
 # Make Openstack object available in Chef::Recipe
24 24
 class ::Chef::Recipe

+ 0
- 10
spec/identity_registration_spec.rb View File

@@ -68,16 +68,6 @@ describe 'openstack-network::identity_registration' do
68 68
         service_user
69 69
       ).with(
70 70
         domain_name: domain_name,
71
-        project_name: project_name,
72
-        password: password,
73
-        connection_params: connection_params
74
-      )
75
-    end
76
-
77
-    it do
78
-      expect(chef_run).to grant_role_openstack_user(
79
-        service_user
80
-      ).with(
81 71
         project_name: project_name,
82 72
         role_name: role_name,
83 73
         password: password,

+ 8
- 8
spec/server_spec.rb View File

@@ -6,12 +6,12 @@ describe 'openstack-network::server' do
6 6
     let(:runner) { ChefSpec::SoloRunner.new(UBUNTU_OPTS) }
7 7
     let(:node) { runner.node }
8 8
     let(:chef_run) do
9
-      node.set['openstack']['compute']['network']['service_type'] = 'neutron'
9
+      node.override['openstack']['compute']['network']['service_type'] = 'neutron'
10 10
       runner.converge(described_recipe)
11 11
     end
12 12
     before do
13
-      node.set['openstack']['network']['plugins']['ml2']['path'] = '/etc/neutron/plugins/ml2'
14
-      node.set['openstack']['network']['plugins']['ml2']['filename'] = 'ml2_conf.ini'
13
+      node.override['openstack']['network']['plugins']['ml2']['path'] = '/etc/neutron/plugins/ml2'
14
+      node.override['openstack']['network']['plugins']['ml2']['filename'] = 'ml2_conf.ini'
15 15
     end
16 16
     include_context 'neutron-stubs'
17 17
 
@@ -22,7 +22,7 @@ describe 'openstack-network::server' do
22 22
 
23 23
       it 'allows overriding package names' do
24 24
         cust_pkgs = ['my-neutron', 'my-other-neutron']
25
-        node.set['openstack']['network']['platform']['neutron_server_packages'] = cust_pkgs
25
+        node.override['openstack']['network']['platform']['neutron_server_packages'] = cust_pkgs
26 26
 
27 27
         cust_pkgs.each do |pkg|
28 28
           expect(chef_run).to upgrade_package(pkg)
@@ -45,13 +45,13 @@ describe 'openstack-network::server' do
45 45
       end
46 46
 
47 47
       it do
48
-        node.set['openstack']['network']['policyfile_url'] = 'http://www.someurl.com'
48
+        node.override['openstack']['network']['policyfile_url'] = 'http://www.someurl.com'
49 49
         expect(neutron_service)
50 50
           .to subscribe_to('remote_file[/etc/neutron/policy.json]').on(:restart).delayed
51 51
       end
52 52
 
53 53
       it 'allows overriding service names' do
54
-        node.set['openstack']['network']['platform']['neutron_server_service'] = 'my-neutron-server'
54
+        node.override['openstack']['network']['platform']['neutron_server_service'] = 'my-neutron-server'
55 55
 
56 56
         expect(chef_run).to enable_service('neutron-server').with(
57 57
           service_name: 'my-neutron-server'
@@ -59,8 +59,8 @@ describe 'openstack-network::server' do
59 59
       end
60 60
 
61 61
       it 'allows overriding package options' do
62
-        cust_opts = "-o Dpkg::Options::='--force-confold' -o Dpkg::Options::='--force-confdef' --force-yes"
63
-        node.set['openstack']['network']['platform']['package_overrides'] = cust_opts
62
+        cust_opts = ['-o', 'Dpkg::Options::=--force-confold', '-o', 'Dpkg::Options::=--force-confdef', '--force-yes']
63
+        node.override['openstack']['network']['platform']['package_overrides'] = cust_opts
64 64
 
65 65
         expect(chef_run).to upgrade_package('neutron-server').with(options: cust_opts)
66 66
       end

+ 2
- 2
spec/spec_helper.rb View File

@@ -10,7 +10,7 @@ require 'chef/application'
10 10
 LOG_LEVEL = :fatal
11 11
 REDHAT_OPTS = {
12 12
   platform: 'redhat',
13
-  version: '7.1',
13
+  version: '7.3',
14 14
   log_level: LOG_LEVEL,
15 15
 }.freeze
16 16
 UBUNTU_OPTS = {
@@ -20,7 +20,7 @@ UBUNTU_OPTS = {
20 20
 }.freeze
21 21
 CENTOS_OPTS = {
22 22
   platform: 'centos',
23
-  version: '7.2.1511',
23
+  version: '7.3.1611',
24 24
   log_level: LOG_LEVEL,
25 25
 }.freeze
26 26
 

Loading…
Cancel
Save