Merge "Use openstack cli to manage neutron networks"

This commit is contained in:
Zuul 2021-11-29 16:54:14 +00:00 committed by Gerrit Code Review
commit 9d1413d13e
4 changed files with 499 additions and 327 deletions

View File

@ -1,185 +0,0 @@
require File.join(File.dirname(__FILE__), '..','..','..',
'puppet/provider/neutron')
Puppet::Type.type(:neutron_network).provide(
:neutron,
:parent => Puppet::Provider::Neutron
) do
desc <<-EOT
Neutron provider to manage neutron_network type.
Assumes that the neutron service is configured on the same host.
EOT
mk_resource_methods
def self.neutron_type
'net'
end
def self.do_not_manage
@do_not_manage
end
def self.do_not_manage=(value)
@do_not_manage = value
end
def self.search_attr(attrs,attr)
if attrs.key?(attr)
attrs[attr]
else
attr_rep = attr.gsub(':','_')
attrs[attr_rep]
end
end
def self.instances
self.do_not_manage = true
list = list_neutron_resources(neutron_type).collect do |id|
attrs = get_neutron_resource_attrs(neutron_type, id)
new(
:ensure => :present,
:name => attrs['name'],
:id => attrs['id'],
:admin_state_up => attrs['admin_state_up'],
:provider_network_type => search_attr(attrs,'provider:network_type'),
:provider_physical_network => search_attr(attrs,'provider:physical_network'),
:provider_segmentation_id => search_attr(attrs,'provider:segmentation_id'),
:router_external => search_attr(attrs,'router:external'),
:shared => attrs['shared'],
:tenant_id => attrs['tenant_id'],
:availability_zone_hint => attrs['availability_zone_hint']
)
end
self.do_not_manage = false
list
end
def self.prefetch(resources)
networks = instances
resources.keys.each do |name|
if provider = networks.find{ |net| net.name == name }
resources[name].provider = provider
end
end
end
def exists?
@property_hash[:ensure] == :present
end
def create
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
network_opts = Array.new
if @resource[:shared] =~ /true/i
network_opts << '--shared'
end
if @resource[:tenant_name]
tenant_id = self.class.get_tenant_id(@resource.catalog,
@resource[:tenant_name])
network_opts << "--tenant_id=#{tenant_id}"
elsif @resource[:tenant_id]
network_opts << "--tenant_id=#{@resource[:tenant_id]}"
end
if @resource[:provider_network_type]
network_opts << \
"--provider:network_type=#{@resource[:provider_network_type]}"
end
if @resource[:provider_physical_network]
network_opts << \
"--provider:physical_network=#{@resource[:provider_physical_network]}"
end
if @resource[:provider_segmentation_id]
network_opts << \
"--provider:segmentation_id=#{@resource[:provider_segmentation_id]}"
end
if @resource[:router_external] == 'True'
network_opts << '--router:external'
end
if @resource[:availability_zone_hint]
network_opts << \
"--availability-zone-hint=#{@resource[:availability_zone_hint]}"
end
results = auth_neutron('net-create', '--format=shell',
network_opts, resource[:name])
attrs = self.class.parse_creation_output(results)
@property_hash = {
:ensure => :present,
:name => resource[:name],
:id => attrs['id'],
:admin_state_up => attrs['admin_state_up'],
:provider_network_type => self.class.search_attr(attrs,'provider:network_type'),
:provider_physical_network => self.class.search_attr(attrs,'provider:physical_network'),
:provider_segmentation_id => self.class.search_attr(attrs,'provider:segmentation_id'),
:router_external => self.class.search_attr(attrs,'router:external'),
:shared => attrs['shared'],
:tenant_id => attrs['tenant_id'],
:availability_zone_hint => attrs['availability_zone_hint']
}
end
def destroy
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
auth_neutron('net-delete', name)
@property_hash[:ensure] = :absent
end
def admin_state_up=(value)
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
auth_neutron('net-update', "--admin_state_up=#{value}", name)
end
def shared=(value)
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
auth_neutron('net-update', "--shared=#{value}", name)
end
def router_external=(value)
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
if value == 'False'
auth_neutron('net-update', "--router:external=#{value}", name)
else
auth_neutron('net-update', "--router:external", name)
end
end
def availability_zone_hint=(value)
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
auth_neutron('net-update', "--availability-zone-hint=#{value}", name)
end
[
:provider_network_type,
:provider_physical_network,
:provider_segmentation_id,
:tenant_id,
].each do |attr|
define_method(attr.to_s + "=") do |value|
fail("Property #{attr.to_s} does not support being updated")
end
end
end

View File

@ -0,0 +1,205 @@
require File.join(File.dirname(__FILE__), '..','..','..',
'puppet/provider/neutron')
Puppet::Type.type(:neutron_network).provide(
:openstack,
:parent => Puppet::Provider::Neutron
) do
desc <<-EOT
Neutron provider to manage neutron_network type.
Assumes that the neutron service is configured on the same host.
EOT
@credentials = Puppet::Provider::Openstack::CredentialsV3.new
mk_resource_methods
def initialize(value={})
super(value)
@property_flush = {}
end
def self.do_not_manage
@do_not_manage
end
def self.do_not_manage=(value)
@do_not_manage = value
end
def self.instances
self.do_not_manage = true
list = request('network', 'list').collect do |attrs|
network = request('network', 'show', attrs[:id])
new(
:ensure => :present,
:name => attrs[:name],
:id => attrs[:id],
:admin_state_up => network[:admin_state_up],
:provider_network_type => network[:provider_network_type],
:provider_physical_network => network[:provider_physical_network],
:provider_segmentation_id => network[:provider_segmentation_id],
:router_external => network[:router_external],
:shared => network[:shared],
:tenant_id => network[:project_id],
:availability_zone_hint => parse_availability_zone_hint(network[:availability_zone_hints])
)
end
self.do_not_manage = false
list
end
def self.prefetch(resources)
networks = instances
resources.keys.each do |name|
if provider = networks.find{ |net| net.name == name }
resources[name].provider = provider
end
end
end
def exists?
@property_hash[:ensure] == :present
end
def create
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
opts = [@resource[:name]]
if @resource[:shared] =~ /true/i
opts << '--share'
end
if @resource[:admin_state_up] == 'False'
opts << '--disable'
end
if @resource[:tenant_name]
opts << "--project=#{@resource[:tenant_name]}"
elsif @resource[:tenant_id]
opts << "--project=#{@resource[:tenant_id]}"
end
if @resource[:provider_network_type]
opts << \
"--provider-network-type=#{@resource[:provider_network_type]}"
end
if @resource[:provider_physical_network]
opts << \
"--provider-physical-network=#{@resource[:provider_physical_network]}"
end
if @resource[:provider_segmentation_id]
opts << \
"--provider-segmentation-id=#{@resource[:provider_segmentation_id]}"
end
if @resource[:router_external] == 'True'
opts << '--external'
end
if @resource[:availability_zone_hint]
Array(@resource[:availability_zone_hint]).each do |hint|
opts << "--availability-zone-hint=#{hint}"
end
end
network = self.class.request('network', 'create', opts)
@property_hash = {
:ensure => :present,
:name => network[:name],
:id => network[:id],
:admin_state_up => network[:admin_state_up],
:provider_network_type => network[:provider_network_type],
:provider_physical_network => network[:provider_physical_network],
:provider_segmentation_id => network[:provider_segmentation_id],
:router_external => network[:router_external],
:shared => network[:shared],
:tenant_id => network[:project_id],
:availability_zone_hint => self.class.parse_availability_zone_hint(network[:availability_zone_hints])
}
end
def flush
if !@property_flush.empty?
opts = [@resource[:name]]
if @property_flush.has_key?(:admin_state_up)
if @property_flush[:admin_state_up] == 'False'
opts << '--disable'
else
opts << '--enable'
end
end
if @property_flush.has_key?(:shared)
if @property_flush[:shared] == 'False'
opts << '--no-share'
else
opts << '--share'
end
end
if @property_flush.has_key?(:router_external)
if @property_flush[:router_external] == 'False'
opts << '--internal'
else
opts << '--external'
end
end
self.class.request('network', 'set', opts)
@property_flush.clear
end
end
def destroy
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
self.class.request('network', 'delete', @resource[:name])
@property_hash.clear
@property_hash[:ensure] = :absent
end
def self.parse_availability_zone_hint(value)
hints = JSON.parse(value.gsub(/\\"/,'"').gsub('u\'', '"').gsub('\'','"'))
if hints.length > 1
hints
else
hints.first
end
end
[
:admin_state_up,
:shared,
:router_external,
].each do |attr|
define_method(attr.to_s + "=") do |value|
if self.class.do_not_manage
fail("Not managing Neutron_network[#{@resource[:name]}] due to earlier Neutron API failures.")
end
@property_flush[attr] = value
end
end
[
:availability_zone_hint,
:provider_network_type,
:provider_physical_network,
:provider_segmentation_id,
:tenant_id,
:tenant_name,
].each do |attr|
define_method(attr.to_s + "=") do |value|
fail("Property #{attr.to_s} does not support being updated")
end
end
end

View File

@ -1,142 +0,0 @@
require 'puppet'
require 'spec_helper'
require 'puppet/provider/neutron_network/neutron'
provider_class = Puppet::Type.type(:neutron_network).provider(:neutron)
describe provider_class do
let :net_name do
'net1'
end
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
:admin_state_up => 'True',
:router_external => 'False',
:shared => 'False',
:tenant_id => '60f9544eb94c42a6b7e8e98c2be981b1',
}
end
let :resource do
Puppet::Type::Neutron_network.new(net_attrs)
end
let :provider do
provider_class.new(resource)
end
shared_examples 'neutron_network' do
describe 'when creating a non-shared network' do
it 'should call net-create with appropriate command line options' do
provider.class.stubs(:get_tenant_id).returns(net_attrs[:tenant_id])
output = 'Created a new network:
admin_state_up="True"
id="d9ac3494-20ea-406c-a4ba-145923dfadc9"
name="net1"
shared="False"
status="ACTIVE"
subnets=""
tenant_id="60f9544eb94c42a6b7e8e98c2be981b1"'
provider.expects(:auth_neutron).with('net-create',
'--format=shell', ["--tenant_id=#{net_attrs[:tenant_id]}"],
net_name).returns(output)
provider.create
end
end
describe 'when creating a shared network' do
let :local_attrs do
attrs = net_attrs.merge({:shared => 'True'})
end
it 'should call net-create with appropriate command line options' do
provider.class.stubs(:get_tenant_id).returns(net_attrs[:tenant_id])
output = 'Created a new network:
admin_state_up="True"
id="d9ac3494-20ea-406c-a4ba-145923dfadc9"
name="net1"
shared="True"
status="ACTIVE"
subnets=""
tenant_id="60f9544eb94c42a6b7e8e98c2be981b1"'
provider.expects(:auth_neutron).with('net-create',
'--format=shell', ['--shared', "--tenant_id=#{net_attrs[:tenant_id]}"],
net_name).returns(output)
provider.create
end
end
describe 'when updating a network' do
it 'should call net-update to change admin_state_up' do
provider.expects(:auth_neutron).with('net-update',
'--admin_state_up=False',
net_name)
provider.admin_state_up=('False')
end
it 'should call net-update to change shared' do
provider.expects(:auth_neutron).with('net-update',
'--shared=True',
net_name)
provider.shared=('True')
end
it 'should call net-update to change router_external' do
provider.expects(:auth_neutron).with('net-update',
'--router:external=False',
net_name)
provider.router_external=('False')
end
it 'should call net-update to change router_external' do
provider.expects(:auth_neutron).with('net-update',
'--router:external',
net_name)
provider.router_external=('True')
end
[:provider_network_type, :provider_physical_network, :provider_segmentation_id].each do |attr|
it "should fail when #{attr.to_s} is update " do
expect do
provider.send("#{attr}=", 'foo')
end.to raise_error(Puppet::Error, /does not support being updated/)
end
end
end
end
describe "with tenant_name set" do
let :local_attrs do
attrs = net_attrs.merge({:tenant_name => 'a_person'})
attrs.delete(:tenant_id)
attrs
end
let :resource do
Puppet::Type::Neutron_network.new(local_attrs)
end
let :provider do
provider_class.new(resource)
end
it_behaves_like('neutron_network')
end
end

View File

@ -0,0 +1,294 @@
require 'puppet'
require 'spec_helper'
require 'puppet/provider/neutron_network/openstack'
provider_class = Puppet::Type.type(:neutron_network).provider(:openstack)
describe provider_class do
let(:set_env) do
ENV['OS_USERNAME'] = 'test'
ENV['OS_PASSWORD'] = 'abc123'
ENV['OS_PROJECT_NAME'] = 'test'
ENV['OS_AUTH_URL'] = 'http://127.0.0.1:5000'
end
describe 'manage networks' do
let :net_name do
'net1'
end
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
}
end
let :resource do
Puppet::Type::Neutron_network.new(net_attrs)
end
let :provider do
provider_class.new(resource)
end
before :each do
set_env
end
describe '#create' do
context 'with defaults' do
it 'creates network' do
provider_class.expects(:openstack)
.with('network', 'create', '--format', 'shell',
['net1'])
.returns('admin_state_up="True"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="False"
shared="False"')
provider.create
expect(provider.exists?).to be_truthy
expect(provider.admin_state_up).to eq('True')
expect(provider.tenant_id).to eq('60f9544eb94c42a6b7e8e98c2be981b1')
expect(provider.router_external).to eq('False')
expect(provider.shared).to eq('False')
end
end
context 'with admin_state_up' do
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
:admin_state_up => 'False',
}
end
it 'creates network' do
provider_class.expects(:openstack)
.with('network', 'create', '--format', 'shell',
['net1', '--disable'])
.returns('admin_state_up="False"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="False"
shared="False"')
provider.create
expect(provider.exists?).to be_truthy
expect(provider.admin_state_up).to eq('False')
end
end
context 'with shared' do
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
:shared => 'True',
}
end
it 'creates network' do
provider_class.expects(:openstack)
.with('network', 'create', '--format', 'shell',
['net1', '--share'])
.returns('admin_state_up="True"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="False"
shared="True"')
provider.create
expect(provider.exists?).to be_truthy
expect(provider.shared).to eq('True')
end
end
context 'with tenant_name' do
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
:tenant_name => 'openstack',
}
end
it 'creates network' do
provider_class.expects(:openstack)
.with('network', 'create', '--format', 'shell',
['net1', '--project=openstack'])
.returns('admin_state_up="True"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="False"
shared="False"')
provider.create
expect(provider.exists?).to be_truthy
end
end
context 'with provider_network' do
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
:provider_network_type => 'vlan',
:provider_physical_network => 'datacentre',
:provider_segmentation_id => 10,
}
end
it 'creates network' do
provider_class.expects(:openstack)
.with('network', 'create', '--format', 'shell',
['net1', '--provider-network-type=vlan',
'--provider-physical-network=datacentre',
'--provider-segmentation-id=10'])
.returns('admin_state_up="True"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
provider_network_type="vlan"
provider_physical_network="datacentre"
provider_segmentation_id="10"
router_external="False"
shared="False"')
provider.create
expect(provider.exists?).to be_truthy
expect(provider.provider_network_type).to eq('vlan')
expect(provider.provider_physical_network).to eq('datacentre')
expect(provider.provider_segmentation_id).to eq('10')
end
end
context 'with router_external' do
let :net_attrs do
{
:name => net_name,
:ensure => 'present',
:router_external => 'True',
}
end
it 'creates network' do
provider_class.expects(:openstack)
.with('network', 'create', '--format', 'shell',
['net1', '--external'])
.returns('admin_state_up="True"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="True"
shared="False"')
provider.create
expect(provider.exists?).to be_truthy
expect(provider.router_external).to eq('True')
end
end
end
describe '#destroy' do
it 'removes network' do
provider_class.expects(:openstack)
.with('network', 'delete', 'net1')
provider.destroy
expect(provider.exists?).to be_falsey
end
end
describe '#flush' do
context '.admin_state_up' do
it 'updates network' do
provider_class.expects(:openstack)
.with('network', 'set', ['net1', '--disable'])
provider.admin_state_up = 'False'
provider.flush
provider_class.expects(:openstack)
.with('network', 'set', ['net1', '--enable'])
provider.admin_state_up = 'True'
provider.flush
end
end
context '.shared' do
it 'updates network' do
provider_class.expects(:openstack)
.with('network', 'set', ['net1', '--share'])
provider.shared = 'True'
provider.flush
provider_class.expects(:openstack)
.with('network', 'set', ['net1', '--no-share'])
provider.shared = 'False'
provider.flush
end
end
context '.router_external' do
it 'updates network' do
provider_class.expects(:openstack)
.with('network', 'set', ['net1', '--external'])
provider.router_external = 'True'
provider.flush
provider_class.expects(:openstack)
.with('network', 'set', ['net1', '--internal'])
provider.router_external = 'False'
provider.flush
end
end
end
describe '#instances' do
it 'lists networks' do
provider_class.expects(:openstack)
.with('network', 'list', '--quiet', '--format', 'csv', [])
.returns('"ID","Name","Subnets"
"076520cc-b783-4cf5-a4a9-4cb5a5e93a9b","net1","[\'dd5e0ef1-2c88-4b0b-ba08-7df65be87963\']",
"34e8f42b-89db-4a5b-92db-76ca7073414d","net2","[\'0da7a631-0f8f-4e51-8b1c-7a29d0d4f7b5\']",
')
provider_class.expects(:openstack)
.with('network', 'show', '--format', 'shell',
'076520cc-b783-4cf5-a4a9-4cb5a5e93a9b')
.returns('admin_state_up="True"
availability_zone_hints="[]"
id="076520cc-b783-4cf5-a4a9-4cb5a5e93a9b"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="False"
shared="False"')
provider_class.expects(:openstack)
.with('network', 'show', '--format', 'shell',
'34e8f42b-89db-4a5b-92db-76ca7073414d')
.returns('admin_state_up="False"
availability_zone_hints="[]"
id="34e8f42b-89db-4a5b-92db-76ca7073414d"
project_id="60f9544eb94c42a6b7e8e98c2be981b1"
router_external="True"
shared="True"')
instances = provider_class.instances
expect(instances.length).to eq(2)
expect(instances[0].id).to eq('076520cc-b783-4cf5-a4a9-4cb5a5e93a9b')
expect(instances[0].name).to eq('net1')
expect(instances[0].admin_state_up).to eq('True')
expect(instances[0].router_external).to eq('False')
expect(instances[0].tenant_id).to eq('60f9544eb94c42a6b7e8e98c2be981b1')
expect(instances[0].shared).to eq('False')
expect(instances[1].id).to eq('34e8f42b-89db-4a5b-92db-76ca7073414d')
expect(instances[1].name).to eq('net2')
expect(instances[1].admin_state_up).to eq('False')
expect(instances[1].tenant_id).to eq('60f9544eb94c42a6b7e8e98c2be981b1')
expect(instances[1].router_external).to eq('True')
expect(instances[1].shared).to eq('True')
end
end
end
end