dewiring 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzZlOTQxOTc2YzIyMmExOWQ1OGJmZmRmYzQ4MDRlMWJiMTZkMmI0Yg==
+    MWI3MDA5Yzc1ZGNhY2JlNzJiYjQyMTJjMmQwNTJiNWU5Njc0NzhmNw==
   data.tar.gz: !binary |-
-    OGRjNWIyNWNlYjFkMGFkOTM1OTRkYWI4YWY0NTRlY2I4YWFiYTgwMg==
+    NDIxM2Y4Mzc2NDM4NzYwMzQ4MzJmYzFiMzYzOTBlMjJjMDY1NWEyNw==
 SHA512:
   metadata.gz: !binary |-
-    ZjNmNzNhNDUzYTU2YzBkNmFmYWEyMWQ5Y2I2Mzk3ZDJjZjA3MmUxNGE5ODFm
-    OGEwYjk3N2I1NDQ4MDgyYzNmZDJkODVhZWNlYjA5MDE3M2JhMDBiMzQyMGQ3
-    MWRiODg2NGQ1MzRlNTFjNzQ3MWQ2YWM0MDI4Y2NjODJhNzVmOTQ=
+    NDY5OGNmMzIxNjJmZTUwM2I5NTZhZjVkNzM2NjZmNzg5YTAyMTk4OTJkMjZk
+    M2FhYzNmODI4YWM5ZjE4NzU4MDk0OGY5MjI5N2MwMmZkNWU0ZWNhNWU3OTM5
+    ZThmNDQ3ZDYzMDhlMWI4N2MwY2YzZjFiNzI4Mzc2ZTRiNTllNmM=
   data.tar.gz: !binary |-
-    MjNiNjllYTJiZjU2YWJmNGZiOGJmMDEyMTBiYjNmNzUxOTJlZTQwMmJkZDkx
-    ZDUzYmI5ZjJlMTM1OTBjM2RhYTdhYjdjZGVlMDhlZTY2ODhlMDA0YTI0ZGMz
-    NDhjN2IxODMxOWUwMmI5ZTIzZTExM2UyMjU0MjgwMTBjYmEwNjU=
+    ZGYxNDY4Yzg1MTM3NDZhZjIyMzJhMThmOTUxMWE4Zjc0YzMzYTQyY2NkNWI4
+    ZGFhMWQ4YzNkN2E4ZDdiYjIxZmNhYmQyZDg2NTk5MmExMjEwOTU3YzVjM2Vh
+    NjE1ZTUwMTA3MTliYzlkZjdjNTYwNjg2OTU1YjdkYWQxMGMzZjc=

data/lib/wire-network-container.sh

@@ -23,9 +23,9 @@ function usage() {
  	    echo '    -n/--noop 	only print commands, do not change'
  	    echo '    -d/--debug 	show debug output'
  	    echo '    -q/--quiet 	be quiet'
- 	    # echo '    -s/--state <FILE>   write state to <FILE>'  # TODO
+ 	    echo '    -s/--state <FILE>   write state to <FILE>'
 	    echo '  Examples:'
-	    echo '   attach-containers.sh attach --debug -- eth1:br1 eth2:br2 02978729 12673482'
+	    echo '   attach-containers.sh attach --debug -- eth1:br1:NODHCP eth2:br2 02978729 12673482'
 	    echo '   attach-containers.sh verify -- eth1:br1 eth2:br2 02978729 12673482'
 	    echo '   attach-containers.sh detach -q -- eth1:br1 eth2:br2 02978729 12673482'
 }
@@ -64,6 +64,7 @@ MODE=
 ACTION=
 DEBUG=nodebug
 QUIET=
+STATEFILE=
 
 while :
 do
@@ -80,6 +81,11 @@ do
           NOOP=1
 	      shift
           ;;
+      -s | --state)
+	      shift
+	      STATEFILE=$1
+	      shift
+          ;;
       -d | --debug)
           DEBUG=debug
 	      shift
@@ -124,6 +130,12 @@ if [[ -z "$ID_ARR" ]]; then
 	exit 3
 fi
 
+# empty state file
+if [[ ! -z "$STATEFILE" ]]; then
+    echo "# This is a wire network state file" >"$STATEFILE"
+    echo "TIMESTAMP=`date`" >>"$STATEFILE"
+fi
+
 [[ "$NOOP" -eq 1 ]] && MODE='echo NOOP% '
 
 # DEBUG
@@ -136,12 +148,25 @@ OVS_VSCTL=$(which ovs-vsctl)
 DOCKER=$(which docker)
 DHCLIENT=$(which dhclient)
 
+# -- FUNCTION ----------------------------------------------------------------
+#        Name: add_to_state
+# Description: Adds given text line to state file. If STATEFILE is empty,
+#              nothing is done
+# Parameters
+#           1: state info line
+# ----------------------------------------------------------------------------
+function add_to_state() {
+    if [[ ! -z "$STATEFILE" ]]; then
+        echo $* >>"$STATEFILE"
+	fi
+}
+
 # -- FUNCTION ----------------------------------------------------------------
 #        Name: container_process
 # Description: Given ID of container, this returns the Process id
 # Parameters
 #           1: Docker Container ID
-# Returns    : Container Process ID 
+# Returns    : Container Process ID
 # ----------------------------------------------------------------------------
 function container_process() {
 	T="$1"
@@ -170,7 +195,11 @@ function link_netns() {
 # ----------------------------------------------------------------------------
 function unlink_netns() {
 	local PID=$1
-	$MODE sudo rm /var/run/netns/$PID
+	if [[ -z $PID ]]; then
+	    log_error unlink_netns: pid not specified
+	else
+	    $MODE sudo rm "/var/run/netns/$PID"
+    fi
 }
 
 # -- FUNCTION ----------------------------------------------------------------
@@ -292,11 +321,11 @@ function has_interfaces() {
 	if [[ $? -ne 0 ]]; then
 		return 1
 	fi
-	# check if we have an ip
-	$MODE sudo $IP netns exec $NS $IP addr show $DEVICE 2>&1 | grep 'inet ' >/dev/null 2>&1
-	if [[ $? -ne 0 ]]; then
-		return 1
-	fi
+	# check if we have an ip (todo: fix in NODHCP mode)
+	#$MODE sudo $IP netns exec $NS $IP addr show $DEVICE 2>&1 | grep 'inet ' >/dev/null 2>&1
+	#if [[ $? -ne 0 ]]; then
+	#	return 1
+	#fi
 
 	# host devices
 	$MODE sudo $IP link show $HOST_IF >/dev/null 2>&1 
@@ -376,8 +405,9 @@ function handle_verify() {
 				# on host and in container
 	
 				$DEBUG - Checking devices in $ID
-        			link_netns "${PID}"
-        			
+        		link_netns "${PID}"
+                add_to_state ${ID}.CONTAINER_PID=${TARGET_PID}
+
 				# iterate given devices
 				for DEVICE_PAIR in $DEVICE_ARR; do
 					INTF=$(echo "$DEVICE_PAIR" | awk -F':' '{ print $1 }' )
@@ -419,11 +449,13 @@ function handle_attach() {
         $DEBUG PID of $TARGET is $TARGET_PID
         
         link_netns "${TARGET_PID}"
-        
+        add_to_state ${TARGET}.CONTAINER_PID=${TARGET_PID}
+
 		# iterate given devices
 		for DEVICE_PAIR in $DEVICE_ARR; do
 			INTF=$(echo $DEVICE_PAIR | awk -F':' '{ print $1 }' )
 			BRIDGE=$(echo $DEVICE_PAIR | awk -F':' '{ print $2 }' )
+			FLAGS=$(echo $DEVICE_PAIR | awk -F':' '{ print $3 }' )
 			$DEBUG Attaching $INTF to $BRIDGE
         	
 			BRIDGEDEV_MTU=$(get_mtu $BRIDGE)
@@ -432,6 +464,7 @@ function handle_attach() {
 				RES=1
 				break	
 			fi
+			add_to_state ${TARGET}.BRIDGEDEV_MTU=${BRIDGEDEV_MTU}
 
             HOST_IFNAME=v${INTF}h${TARGET_PID}
             CONTAINER_IFNAME=v${INTF}c${TARGET_PID}
@@ -444,7 +477,10 @@ function handle_attach() {
 				RES=1
 				continue	
 			fi
-        
+
+            add_to_state ${TARGET}.HOST_IFNAME=${HOST_IFNAME}
+            add_to_state ${TARGET}.CONTAINER_IFNAME=${CONTAINER_IFNAME}
+
 			$DEBUG - adding $HOST_IFNAME to $BRIDGE
         	add_device_to_switch "$HOST_IFNAME" "$BRIDGE"
 			if [[ $? -ne 0 ]]; then	
@@ -452,25 +488,35 @@ function handle_attach() {
 				RES=1
 				continue	
 			fi
-        
+            add_to_state ${TARGET}.ON_BRIDGE=$BRIDGE
+
 			$DEBUG - configuring interfaces
         	configure_interfaces "$HOST_IFNAME" "$CONTAINER_IFNAME" "$TARGET_PID" "$INTF"
 			if [[ $? -ne 0 ]]; then	
 				log_error configuring interfaces. aborting
 				RES=1
-				continue	
-			fi
-        	
-			$DEBUG - dhcp requesting address
-        	dhcp_container "$TARGET_PID" "$INTF"
-			if [[ $? -ne 0 ]]; then	
-				log_error running dhcp. aborting
-				RES=1
-				continue	
+                add_to_state ${CONTAINER_IFNAME}.configured=error
+				continue
 			fi
-        	done
+            add_to_state ${TARGET}.${CONTAINER_IFNAME}.configured=ok
 
-        	unlink_netns "$TARGET_PID"
+        	if [[ "$FLAGS" =~ NODHCP ]]; then
+			    $DEBUG - skipping dhcp for $INTF
+			else
+			    $DEBUG - dhcp requesting address
+        	    dhcp_container "$TARGET_PID" "$INTF"
+			    if [[ $? -ne 0 ]]; then
+				    log_error running dhcp. aborting
+                    add_to_state ${CONTAINER_IFNAME}.dhcp=error
+				    RES=1
+				    continue
+			    fi
+			    add_to_state ${TARGET}.${CONTAINER_IFNAME}.dhcp=ok
+
+        	fi
+
+        done
+        unlink_netns "$TARGET_PID"
 	done
 
 	return $RES
@@ -490,10 +536,10 @@ function handle_detach() {
 		$DEBUG Detaching $TARGET
 	
 		TARGET_PID=$(container_process $TARGET)
-        	$DEBUG PID of $TARGET is $TARGET_PID
-        
-        	link_netns ${TARGET_PID}
+        $DEBUG PID of $TARGET is $TARGET_PID
         
+        link_netns ${TARGET_PID}
+
 		# iterate given devices
 		for DEVICE_PAIR in $DEVICE_ARR; do
 			INTF=$(echo $DEVICE_PAIR | awk -F':' '{ print $1 }' )

data/lib/wire/commands/base_command.rb

@@ -113,6 +113,37 @@ module Wire
       end
     end
 
+    # brings given +resource+ up by first asking if its up?.
+    # If not, call up. Writes states, outputs state
+    # Params:
+    # ++resource++: Resource object, i.e. BridgeResource
+    # ++resource_type++: Resource type symbol, i.e. :bridge
+    # ++resource_desc_str++: Description to dump out
+    # ++action++: one of :up, :down
+    def default_handle_resource(resource, resource_type, resource_desc_str, action)
+      question = "#{action}?".to_sym
+      output_method = action.to_s.upcase
+
+      b_ok = false
+
+      if resource.send(question)
+        outputs output_method, "#{resource_desc_str} is already #{action}.", :ok2
+        b_ok = true
+      else
+        resource.send(action)
+
+        if resource.send(question)
+          outputs output_method, "#{resource_desc_str} is #{action}.", :ok
+          b_ok = true
+        else
+          outputs output_method, "#{resource_desc_str} could not be brought #{action}.", :err
+        end
+      end
+
+      state.update(resource_type, resource.name, action) if b_ok
+      b_ok
+    end
+
     private
 
     # Save state to state file
@@ -122,18 +153,15 @@ module Wire
       state.save
     rescue => save_exception
       $stderr.puts "Error saving state, #{save_exception}"
-      $log.debug? && puts(save_exception.inspect)
-      $log.debug? && puts(save_exception.backtrace)
     end
 
+    # Load state from state file
     def handle_state_load
       state.load
       # dump state
       $log.debug? && dump_state
     rescue => load_exception
       $stderr.puts "Error loading state, #{load_exception}"
-      $log.debug? && puts(load_exception.inspect)
-      $log.debug? && puts(load_exception.backtrace)
     end
   end
 end

data/lib/wire/commands/down_command.rb

@@ -38,6 +38,7 @@ module Wire
         success = handler.handle_network_attachments(zone_name, zone_networks,
                                                      appgroup_name, appgroup_data,
                                                      @project.target_dir)
+
         b_result &= success
 
         # then take down containers

data/lib/wire/commands/down_command_handler.rb

@@ -7,32 +7,19 @@
 # Wire module
 module Wire
   # implements handle_xxx methods for DownCommand
+  # delegates to BaseCommand.default_handle_resource for most parts
   # rubocop:disable ClassLength
   class DownCommandHandler < BaseCommand
     # take bridge down
     def handle_bridge(bridge_name)
       bridge_resource = Wire::Resource::ResourceFactory.instance.create(:ovsbridge, bridge_name)
-      if bridge_resource.down?
-        outputs 'DOWN', "Bridge #{bridge_name} already down.", :ok2
-        return true
-      end
-
-      bridge_resource.down
-      if bridge_resource.down?
-        outputs 'DOWN', "Bridge #{bridge_name} down/removed.", :ok
-        state.update(:bridge, bridge_name, :down)
-      else
-        outputs 'DOWN', "Error bringing down bridge #{bridge_name}.", :err
-        b_result = false
-      end
-
-      b_result
+      default_handle_resource(bridge_resource, :bridge, "Bridge \'#{bridge_name}\'", :down)
+    rescue => e
+      $log.error "processing bridge: #{e}"
     end
 
     # remove ip from bridge interface
     def handle_hostip(bridge_name, hostip)
-      b_result = true
-
       bridge_resource = Wire::Resource::ResourceFactory.instance.create(:ovsbridge, bridge_name)
       if bridge_resource.down?
         outputs 'DOWN', "Bridge #{bridge_name} already down, will not care about ip", :ok2
@@ -42,22 +29,10 @@ module Wire
       # we should have a bridge with that name.
       hostip_resource = Wire::Resource::ResourceFactory
       .instance.create(:bridgeip, hostip, bridge_name)
-      if hostip_resource.down?
-        outputs 'DOWN', "IP #{hostip} on bridge #{bridge_name} already down.", :ok2
-        return
-      end
-
-      hostip_resource.down
-      if hostip_resource.down?
-        outputs 'DOWN', "IP #{hostip} on bridge #{bridge_name} down/removed.", :ok
-        state.update(:hostip, hostip, :down)
-      else
-        outputs 'DOWN', "Error taking down ip #{hostip} on bridge #{bridge_name}.", :err
-
-        b_result = false
-      end
-
-      b_result
+      default_handle_resource(hostip_resource, :hostip,
+                              "IP \'#{hostip}\' on bridge \'#{bridge_name}\'", :down)
+    rescue => e
+      $log.error "processing host ip: #{e}"
     end
 
     # unconfigures dnsmasq for dhcp
@@ -73,21 +48,10 @@ module Wire
       resource_dhcp = Wire::Resource::ResourceFactory
       .instance.create(:dhcpconfig, "wire__#{zone_name}", network_name,
                        network_entry, address_start, address_end)
-      if resource_dhcp.down?
-        outputs 'DOWN', "dnsmasq/dhcp config on network \'#{network_name}\' is already down.", :ok2
-        return true
-      end
-
-      resource_dhcp.down
-      if resource_dhcp.down?
-        outputs 'DOWN', "dnsmasq/dhcp config on network \'#{network_name}\' is down.", :ok
-        state.update(:dnsmasq, network_name, :down)
-        return true
-      else
-        outputs 'DOWN', 'Error unconfiguring dnsmasq/dhcp ' \
-        "config on network \'#{network_name}\'.", :err
-        return false
-      end
+      default_handle_resource(resource_dhcp, :dnsmasq,
+                              "dnsmasq/dhcp config on network \'#{network_name}\'", :down)
+    rescue => e
+      $log.error "processing dhcp configuration: #{e}"
     end
 
     # take the appgroups' controller and directs methods to
@@ -109,6 +73,8 @@ module Wire
       $log.error "Appgroup not handled for zone #{zone_name}, " \
       "unknown controller type #{controller_entry[:type]}"
       false
+    rescue => e
+      $log.error "processing appgroup: #{e}"
     end
 
     # implement appgroup handling for fig controller
@@ -126,24 +92,10 @@ module Wire
       resource_fig = Wire::Resource::ResourceFactory
       .instance.create(:figadapter, "#{appgroup_name}", fig_path)
 
-      if resource_fig.down?
-        outputs 'DOWN', "appgroup \'#{appgroup_name}\' for zone #{zone_name} is already down.", :ok2
-        return true
-      end
-
-      b_result = false
-      resource_fig.down
-      if resource_fig.down?
-        outputs 'DOWN', "appgroup \'#{appgroup_name}\' for zone #{zone_name} is down.", :ok
-        state.update(:appgroup, appgroup_name, :down)
-        b_result = true
-      else
-        outputs 'DOWN', "Error taking down appgroup \'#{appgroup_name}\' for zone #{zone_name}.",
-                :err
-        b_result = false
-      end
-
-      b_result
+      default_handle_resource(resource_fig, :appgroup,
+                              "appgroup \'#{appgroup_name}\' for zone \'#{zone_name}\'", :down)
+    rescue => e
+      $log.error "processing appgroup/fig: #{e}"
     end
 
     # detaches networks to containers of appgroup
@@ -175,25 +127,13 @@ module Wire
 
       #
       resource_nw = Wire::Resource::ResourceFactory
-      .instance.create(:networkinjection, appgroup_name, networks.keys, container_ids)
-      if resource_nw.down?
-        outputs 'DOWN', "appgroup \'#{appgroup_name}\' network " \
-                'attachments already detached.', :ok2
-        state.update(:appgroup, appgroup_name, :down)
-        return true
-      else
-        resource_nw.down
-        if resource_nw.down?
-          outputs 'DOWN', "appgroup \'#{appgroup_name}\' detached " \
-                  "networks #{networks.keys.join(',')}.", :ok
-          state.update(:appgroup, appgroup_name, :down)
-          return true
-        else
-          outputs 'DOWN', "Error detaching networks to appgroup \'#{appgroup_name}\'.",
-                  :err
-          return false
-        end
-      end
+      .instance.create(:networkinjection, appgroup_name, networks, container_ids)
+
+      default_handle_resource(resource_nw, :network_injection,
+                              "Network(s) \'#{networks.keys.join(',')}\' in "\
+                              "appgroup \'#{appgroup_name}\'", :down)
+    rescue => e
+      $log.error "processing network attachments: #{e}"
     end
   end
 end

data/lib/wire/commands/spec_command.rb

@@ -45,7 +45,7 @@ module Wire
         outputs 'SPEC', 'To run automatically, use --run'
       rescue => exception
         $log.error "Error writing serverspec files, #{exception}"
-        STDERR.puts e.inspect
+        STDERR.puts exception.inspect
       end
 
       run_serverspec(target_specdir) if @params[:auto_run]
@@ -102,14 +102,31 @@ module Wire
     def run_on_network_in_zone(zone_name, bridge_name, network_data)
       $log.debug("Creating specs for network #{bridge_name}")
 
-      template = SpecTemplates.build_template__bridge_exists
+      template = SpecTemplatesNetwork.build_template__bridge_exists
       erb = ERB.new(template, nil, '%')
       @spec_code << erb.result(binding)
 
+      vlan = network_data[:vlan]
+      if vlan
+        vlanid = vlan[:id]
+        on_trunk = vlan[:on_trunk]
+        template = SpecTemplatesNetwork.build_template__bridge_vlan_id_and_trunk
+        erb = ERB.new(template, nil, '%')
+        @spec_code << erb.result(binding)
+      end
+
       # render template for hostip (if any)
       ip = network_data[:hostip]
       if ip
-        template = SpecTemplates.build_template__ip_is_up
+        template = SpecTemplatesNetwork.build_template__ip_is_up
+        erb = ERB.new(template, nil, '%')
+        @spec_code << erb.result(binding)
+      end
+
+      # render template for network/port attachments (if any)
+      attach_intf = network_data[:attach]
+      if attach_intf
+        template = SpecTemplatesNetwork.build_template__port_exists
         erb = ERB.new(template, nil, '%')
         @spec_code << erb.result(binding)
       end
@@ -120,7 +137,7 @@ module Wire
         ip_start = dhcp_data[:start]
         ip_end = dhcp_data[:end]
         hostip = ip
-        template = SpecTemplates.build_template__dhcp_is_valid
+        template = SpecTemplatesNetwork.build_template__dhcp_is_valid
         erb = ERB.new(template, nil, '%')
         @spec_code << erb.result(binding)
 
@@ -147,11 +164,11 @@ module Wire
         figfile_part = controller_data[:file] || "#{zone_name}/fig.yaml"
         figfile = File.join(File.expand_path(@target_dir), figfile_part)
 
-        template = SpecTemplates.build_template__fig_file_is_valid
+        template = SpecTemplatesContainers.build_template__fig_file_is_valid
         erb = ERB.new(template, nil, '%')
         @spec_code << erb.result(binding)
 
-        template = SpecTemplates.build_template__fig_containers_are_up
+        template = SpecTemplatesContainers.build_template__fig_containers_are_up
         erb = ERB.new(template, nil, '%')
         @spec_code << erb.result(binding)
       end
@@ -159,4 +176,4 @@ module Wire
       $log.debug("Done for appgroup #{appgroup_name}")
     end
   end
-end
+end

data/lib/wire/commands/spec_templates.rb

@@ -8,6 +8,53 @@
 module Wire
   # stateless erb template methods used by spec_command.rb
   class SpecTemplates
+    # generate template part
+    # returns
+    # - erb template for spec_helper.rb file
+    def self.template_spec_helper
+      <<ERB
+require 'serverspec'
+
+set :backend, :exec
+ERB
+    end
+
+    # generate template part
+    # returns
+    # - erb template for Rakefile
+    def self.template_rakefile
+      <<ERB
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :spec    => 'spec:all'
+task :default => :spec
+
+namespace :spec do
+  targets = []
+  Dir.glob('./spec/*').each do |dir|
+    next unless File.directory?(dir)
+    targets << File.basename(dir)
+  end
+
+  task :all     => targets
+  task :default => :all
+
+  targets.each do |target|
+    desc "Run serverspec tests to \#{target}"
+    RSpec::Core::RakeTask.new(target.to_sym) do |t|
+      ENV['TARGET_HOST'] = target
+      t.pattern = "spec/\#{target}/*_spec.rb"
+      t.rspec_opts = '--format documentation --color'
+    end
+  end
+end
+ERB
+    end
+  end
+
+  # Templates for network-related stuff
+  class SpecTemplatesNetwork
     # rubocop:disable Lint/UnusedMethodArgument
     # :reek:UnusedParameters
     def self.build_template__bridge_exists
@@ -20,6 +67,38 @@ module Wire
 ERB
     end
 
+    # rubocop:disable Lint/UnusedMethodArgument
+    # :reek:UnusedParameters
+    def self.build_template__port_exists
+      <<ERB
+  describe 'In zone <%= zone_name %> we should have a port <%= attach_intf %> on ovs ' \
+           'bridge <%= bridge_name %>' do
+    describe command "sudo ovs-vsctl list-ports <%= bridge_name %>" do
+      its(:stdout) { should match /<%= attach_intf %>/ }
+    end
+  end
+ERB
+    end
+
+    # rubocop:disable Lint/UnusedMethodArgument
+    # :reek:UnusedParameters
+    def self.build_template__bridge_vlan_id_and_trunk
+      <<ERB
+  describe 'In zone <%= zone_name %>, ovs vlan bridge named <%= bridge_name %> ' \
+           'should have id <%= vlanid %>' do
+    describe command "sudo ovs-vsctl br-to-vlan <%= bridge_name %>" do
+      its(:stdout) { should match /<%= vlanid %>/ }
+    end
+  end
+  describe 'In zone <%= zone_name %>, ovs vlan bridge named <%= bridge_name %> ' \
+           'should have parent <%= on_trunk %>' do
+    describe command "sudo ovs-vsctl br-to-parent <%= bridge_name %>" do
+      its(:stdout) { should match /<%= on_trunk %>/ }
+    end
+  end
+ERB
+    end
+
     # rubocop:disable Lint/UnusedMethodArgument
     # :reek:UnusedParameters
     def self.build_template__ip_is_up
@@ -63,7 +142,10 @@ ERB
   end
 ERB
     end
+  end
 
+  # templates for container-related specs
+  class SpecTemplatesContainers
     # rubocop:disable Lint/UnusedMethodArgument
     # :reek:UnusedParameters
     # requires figfile, appgroup_name
@@ -89,45 +171,6 @@ ERB
       its(:stdout) { should match /Up/ }
     end
   end
-ERB
-    end
-
-    # generate template part
-    # returns
-    # - erb template for spec_helper.rb file
-    def self.template_spec_helper
-      <<ERB
-require 'serverspec'
-require 'rspec/its'
-
-include SpecInfra::Helper::Exec
-include SpecInfra::Helper::DetectOS
-
-RSpec.configure do |c|
-  if ENV['ASK_SUDO_PASSWORD']
-    require 'highline/import'
-    c.sudo_password = ask("Enter sudo password: ") { |q| q.echo = false }
-  else
-    c.sudo_password = ENV['SUDO_PASSWORD']
-  end
-end
-ERB
-    end
-
-    # generate template part
-    # returns
-    # - erb template for Rakefile
-    def self.template_rakefile
-      <<ERB
-require 'rake'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/*/*_spec.rb'
-  t.rspec_opts = '--format documentation --color'
-end
-
-task :default => :spec
 ERB
     end
   end

data/lib/wire/commands/up_command.rb

@@ -59,7 +59,7 @@ module Wire
         zone_networks = objects_in_zone('networks', zone_name)
         success = handler.handle_network_attachments(zone_name, zone_networks,
                                                      appgroup_name, appgroup_data,
-                                                     @project.target_dir)
+                                                     @project.target_dir, @project.vartmp_dir)
         b_result &= success
       end
 

data/lib/wire/commands/up_command_handler.rb

@@ -7,6 +7,7 @@
 # Wire module
 module Wire
   # handle_xxx methods for UpCommand
+  # delegates to BaseCommand.default_handle_resource for most parts
   # rubocop:disable ClassLength
   class UpCommandHandler < BaseCommand
     # bring bridge resource up, identified by
@@ -14,24 +15,13 @@ module Wire
     # Returns
     # - [Bool] true if hostip if up on bridge
     def handle_bridge(bridge_name)
-      b_result = true
-
       # we should have a bridge with that name.
       bridge_resource = Wire::Resource::ResourceFactory.instance.create(:ovsbridge, bridge_name)
-      if bridge_resource.up?
-        outputs 'UP',  "Bridge #{bridge_name} already up.", :ok2
-      else
-        bridge_resource.up
-        if bridge_resource.up?
-          outputs 'UP',  "Bridge #{bridge_name} up.", :ok
-          state.update(:bridge, bridge_name, :up)
-        else
-          outputs 'UP',  "Error bringing up bridge #{bridge_name}.", :err
-          b_result = false
-        end
 
-      end
-      b_result
+      default_handle_resource(bridge_resource, :bridge,
+                              "Bridge \'#{bridge_name}\'", :up)
+    rescue => e
+      $log.error "processing bridge: #{e}"
     end
 
     # bring ip resource up on device identified by
@@ -39,25 +29,14 @@ module Wire
     # Returns
     # - [Bool] true if hostip if up on bridge
     def handle_hostip(bridge_name, hostip)
-      b_result = true
-
       # we should have a bridge with that name.
       hostip_resource = Wire::Resource::ResourceFactory
         .instance.create(:bridgeip, hostip, bridge_name)
-      if hostip_resource.up?
-        outputs 'UP',  "IP #{hostip} on bridge #{bridge_name} already up.", :ok2
-      else
-        hostip_resource.up
-        if hostip_resource.up?
-          outputs 'UP',  "IP #{hostip} on bridge #{bridge_name} up.", :ok
-          state.update(:hostip, hostip, :up)
-        else
-          outputs 'UP',  "Error bringing up ip #{hostip} on bridge #{bridge_name}.", :err
-          b_result = false
-        end
 
-      end
-      b_result
+      default_handle_resource(hostip_resource, :hostip,
+                              "IP \'#{hostip}\' on bridge \'#{bridge_name}\'", :up)
+    rescue => e
+      $log.error "processing host ip: #{e}"
     end
 
     # configures dnsmasq for dhcp
@@ -72,21 +51,11 @@ module Wire
       resource_dhcp = Wire::Resource::ResourceFactory
       .instance.create(:dhcpconfig, "wire__#{zone_name}", network_name,
                        network_entry, address_start, address_end)
-      if resource_dhcp.up?
-        outputs 'UP', "dnsmasq/dhcp config on network \'#{network_name}\' is already up.", :ok2
-        return true
-      else
-        resource_dhcp.up
-        if resource_dhcp.up?
-          outputs 'UP', "dnsmasq/dhcp config on network \'#{network_name}\' is up.", :ok
-          state.update(:dnsmasq, network_name, :up)
-          return true
-        else
-          outputs 'UP', "Error configuring dnsmasq/dhcp config on network \'#{network_name}\'.",
-                  :err
-          return false
-        end
-      end
+
+      default_handle_resource(resource_dhcp, :dnsmasq,
+                              "dnsmasq/dhcp config on network \'#{network_name}\'", :up)
+    rescue => e
+      $log.error "processing dhcp: #{e}"
     end
 
     # take the appgroups' controller and directs methods to
@@ -106,6 +75,8 @@ module Wire
 
       $log.error "Appgroup not handled, unknown controller type #{controller_entry[:type]}"
       false
+    rescue => e
+      $log.error "processing appgroup: #{e}"
     end
 
     # implement appgroup handling for fig controller
@@ -123,21 +94,10 @@ module Wire
       resource_fig = Wire::Resource::ResourceFactory
       .instance.create(:figadapter, "#{appgroup_name}", fig_path)
 
-      if resource_fig.up?
-        outputs 'UP', "appgroup \'#{appgroup_name}\' in zone #{zone_name} is already up.", :ok2
-        return true
-      else
-        resource_fig.up
-        if resource_fig.up?
-          outputs 'UP', "appgroup \'#{appgroup_name}\' in zone #{zone_name} is up.", :ok
-          state.update(:appgroup, appgroup_name, :up)
-          return true
-        else
-          outputs 'UP', "Error bringing up appgroup \'#{appgroup_name}\' in zone #{zone_name} .",
-                  :err
-          return false
-        end
-      end
+      default_handle_resource(resource_fig, :appgroup,
+                              "appgroup \'#{appgroup_name}\' for zone \'#{zone_name}\'", :up)
+    rescue => e
+      $log.error "processing appgroup/fig: #{e}"
     end
 
     # attaches networks to containers of appgroup
@@ -147,10 +107,11 @@ module Wire
     # ++appgroup_name++: Name of appgroup
     # ++appgroup_entry++: appgroup hash
     # ++target_dir++: project target dir
+    # ++state_dir++: project state dir (network statefile is written there)
     # Returns
     # - [Bool] true if appgroup setup is ok
     def handle_network_attachments(_zone_name, networks, appgroup_name,
-                                   appgroup_entry, target_dir)
+                                   appgroup_entry, target_dir, state_dir)
       # query container ids of containers running here
       # get path
       controller_entry = appgroup_entry[:controller]
@@ -168,26 +129,15 @@ module Wire
       end
 
       #
+      statefile_name = File.join(state_dir, ".network_attachment_#{Time.now.to_i}")
       resource_nw = Wire::Resource::ResourceFactory
-      .instance.create(:networkinjection, appgroup_name, networks.keys, container_ids)
-      if resource_nw.up?
-        outputs 'UP', "appgroup \'#{appgroup_name}\' already has valid network " \
-                'attachments.', :ok2
-        state.update(:appgroup, appgroup_name, :up)
-        return true
-      else
-        resource_nw.up
-        if resource_nw.up?
-          outputs 'UP', "appgroup \'#{appgroup_name}\' attached " \
-                  "networks #{networks.keys.join(',')}.", :ok
-          state.update(:appgroup, appgroup_name, :up)
-          return true
-        else
-          outputs 'UP', "Error attaching networks to appgroup \'#{appgroup_name}\'.",
-                  :err
-          return false
-        end
-      end
+      .instance.create(:networkinjection, appgroup_name, networks, container_ids, statefile_name)
+
+      default_handle_resource(resource_nw, :network_injection,
+                              "Network(s) \'#{networks.keys.join(',')}\' in "\
+                              "appgroup \'#{appgroup_name}\'", :up)
+    rescue => e
+      $log.error "processing network attachments: #{e}"
     end
   end
 end

data/lib/wire/commands/verify_command_handler.rb

@@ -8,21 +8,32 @@
 module Wire
   # handle_xxx methods for VerifyCommand
   class VerifyCommandHandler < BaseCommand
+    # asks given +resource+ if it is up. Writes states, outputs state
+    # Params:
+    # ++resource++: Resource object, i.e. BridgeResource
+    # ++resource_type++: Resource type symbol, i.e. :bridge
+    # ++resource_desc_str++: Description to dump out
+    # Returns
+    # [Bool] true = resource is up, false otherwise
+    def default_handle_resource(resource, resource_type, resource_desc_str)
+      if resource.up?
+        outputs 'VERIFY', "#{resource_desc_str} is up.", :ok
+        state.update(resource_type, resource.name, :up)
+        return true
+      else
+        outputs 'VERIFY', "#{resource_desc_str} is not up.", :err
+        state.update(resource_type, resource.name, :down)
+        return false
+      end
+    end
+
     # runs verification for a bridge resource identified by
     # +bridge_name+
     # Returns
     # - [Bool] true if bridge exists
     def handle_bridge(bridge_name)
       bridge_resource = Wire::Resource::ResourceFactory.instance.create(:ovsbridge, bridge_name)
-      if bridge_resource.exist?
-        outputs 'VERIFY', "Bridge \'#{bridge_name}\' exists.", :ok
-        state.update(:bridge, bridge_name, :up)
-        return true
-      else
-        outputs 'VERIFY', "Bridge \'#{bridge_name}\' does not exist.", :err
-        state.update(:bridge, bridge_name, :down)
-        return false
-      end
+      default_handle_resource(bridge_resource, :bridge, "Bridge \'#{bridge_name}\'")
     end
 
     # runs verification for a ip resource identified by
@@ -32,15 +43,8 @@ module Wire
     def handle_hostip(bridge_name, hostip)
       hostip_resource = Wire::Resource::ResourceFactory
         .instance.create(:bridgeip, hostip, bridge_name)
-      if hostip_resource.up?
-        outputs 'VERIFY', "IP \'#{hostip}\' on bridge \'#{bridge_name}\' exists.", :ok
-        state.update(:hostip, hostip, :up)
-        return true
-      else
-        outputs 'VERIFY', "IP \'#{hostip}\' on bridge \'#{bridge_name}\' does not exist.", :err
-        state.update(:hostip, hostip, :down)
-        return false
-      end
+      default_handle_resource(hostip_resource, :hostip,
+                              "IP \'#{hostip}\' on bridge \'#{bridge_name}\'")
     end
 
     # runs verification for dnsmasqs dhcp resource
@@ -50,15 +54,8 @@ module Wire
       resource = Wire::Resource::ResourceFactory
         .instance.create(:dhcpconfig, "wire__#{zone_name}", network_name,
                          network_entry, address_start, address_end)
-      if resource.up?
-        outputs 'VERIFY', "dnsmasq/dhcp config on network \'#{network_name}\' is valid.", :ok
-        state.update(:dnsmasq, network_name, :up)
-        return true
-      else
-        outputs 'VERIFY', "dnsmasq/dhcp config on network \'#{network_name}\' is not valid.", :err
-        state.update(:dnsmasq, network_name, :down)
-        return false
-      end
+      default_handle_resource(resource, :dnsmasq,
+                              "dnsmasq/dhcp config on network \'#{network_name}\'")
     end
 
     # runs verification for appgroups
@@ -73,15 +70,8 @@ module Wire
 
         resource = Wire::Resource::ResourceFactory
           .instance.create(:figadapter, "#{appgroup_name}", fig_path)
-        if resource.up?
-          outputs 'VERIFY', "appgroup \'#{appgroup_name}\' is running.", :ok
-          state.update(:appgroup, appgroup_name, :up)
-          return true
-        else
-          outputs 'VERIFY', "appgroup \'#{appgroup_name}\' is not running.", :err
-          state.update(:appgroup, appgroup_name, :down)
-          return false
-        end
+        return default_handle_resource(resource, :appgroup,
+                                       "Fig Appgroup \'#{appgroup_name}\'")
       end
 
       $log.error "Appgroup not handled, unknown controller type #{controller_entry[:type]}"
@@ -117,18 +107,10 @@ module Wire
 
       #
       resource = Wire::Resource::ResourceFactory
-      .instance.create(:networkinjection, appgroup_name, networks.keys, container_ids)
-      if resource.up?
-        outputs 'VERIFY', "appgroup \'#{appgroup_name}\' has network(s) " \
-        "\'#{networks.keys.join(',')}\' attached.", :ok
-        state.update(:appgroup, appgroup_name, :up)
-        return true
-      else
-        outputs 'VERIFY', "appgroup \'#{appgroup_name}\' does not have " \
-        "all networks \'#{networks.keys.join(',')}\' attached.", :err
-        state.update(:appgroup, appgroup_name, :down)
-        return false
-      end
+      .instance.create(:networkinjection, appgroup_name, networks, container_ids)
+      default_handle_resource(resource, :network_injection,
+                              "Network(s) \'#{networks.keys.join(',')}\' in " \
+                              "appgroup \'#{appgroup_name}\'")
     end
   end
 end

data/lib/wire/execution/local_exec.rb

@@ -12,7 +12,7 @@ module Wire
   module Execution
     # return singleton object
     def self.global_execution_options
-      ExecutionOptions.singleton
+      ExecutionOptions.instance
     end
 
     # Global execution options, such as noop mode etc.

data/lib/wire/model/network_validation.rb

@@ -17,6 +17,7 @@ module Wire
       missing_network_def_found?
       nonmatching_hostips_found?
       dhcp_address_ranges_valid?
+      networks_names_too_long?
     end
 
     # ensures that all networks are attached to a zone
@@ -24,6 +25,20 @@ module Wire
       objects_attached_to_zones? 'networks'
     end
 
+    # ensures that networks with names > 6 chars have
+    # a short name defined, and short names are 6 chars. max.
+    def networks_names_too_long?
+      @project.get_element('networks').each do |network_name, network_data|
+        b_short_name_ok = (network_data[:shortname] && network_data[:shortname].size <= 6)
+
+        mark("Network name #{network_name} too long, please define a :shortname with 6 chars. max.",
+             'network', network_name) if network_name.size > 6 && !b_short_name_ok
+        mark("Network short name of network #{network_name} too long, please define a :shortname " \
+             'with 6 chars. max.',
+             'network', network_name) if network_data[:shortname] && !b_short_name_ok
+      end
+    end
+
     # ensures that all network ranges are unique
     def duplicate_networks_found?
       dup_map = {}
@@ -86,26 +101,26 @@ module Wire
                  'network', network_name)
             return false
           else
-            # check ip ranges
-
-            begin
-              dhcp_start_ip = IPAddr.new(dhcp_data[:start])
-              dhcp_end_ip = IPAddr.new(dhcp_data[:end])
-              network_ip = IPAddr.new(network)
-
-              mark("Network dhcp start ip #{dhcp_data[:start]} is not within network range" \
-                "#{network} of network #{network_name}", 'network', network_name) unless
-                  dhcp_start_ip.in_range_of?(network_ip)
-
-              mark("Network dhcp end ip #{dhcp_data[:end]} is not within network range" \
-                "#{network} of network #{network_name}", 'network', network_name) unless
-                  dhcp_end_ip.in_range_of?(network_ip)
-            rescue => e
-              mark("Network dhcp ip range is not valid: #{e}", 'network', network_name)
-            end
+            check_network_ip_ranges(dhcp_data, network, network_name)
           end
         end
       end
     end
+
+    # check ip ranges of +dhcp_data+ and given +network+
+    # with name +network_name+
+    def check_network_ip_ranges(dhcp_data, network, network_name)
+      network_ip = IPAddr.new(network)
+
+      # check both starting/ending ip range
+      { :start => IPAddr.new(dhcp_data[:start]),
+        :end   => IPAddr.new(dhcp_data[:end]) }.each do |type, data|
+        mark("Network dhcp #{type} ip #{dhcp_data[type]} is not within network range" \
+             "#{network} of network #{network_name}",
+             'network', network_name) unless data.in_range_of?(network_ip)
+      end
+    rescue => e
+      mark("Network dhcp ip range is not valid: #{e}", 'network', network_name)
+    end
   end
 end

data/lib/wire/model/project.rb

@@ -48,6 +48,18 @@ module Wire
       @data[element_name.to_sym]
     end
 
+    # return project's var/tmp directory, will be configurable
+    # in the future
+    def vartmp_dir
+      # as of now, use .state in target dir
+      state_dir = File.join(@target_dir, '.state')
+      unless File.directory? state_dir
+        FileUtils.mkdir_p state_dir
+        $log.debug "created state dir #{state_dir}"
+      end
+      state_dir
+    end
+
     # calculates count statistics on project
     # returns:
     # - [Hash], key => element type, value => [int] count

data/lib/wire/model/state.rb

@@ -114,13 +114,14 @@ module Wire
         @state = YAML.load_file(statefile_filename)
       else
         $log.debug 'No statefile found.'
+        clean
       end
       @changed = false
     end
 
     # construct name of state file
     def state_filename
-      File.join(@project.target_dir, '.state.yaml')
+      File.join(@project.vartmp_dir, '.state.yaml')
     end
   end
 

data/lib/wire/resource/bridge.rb

@@ -30,6 +30,8 @@ module Wire
         }
       end
 
+      # TODO: move to generic execution method
+      # https://codeclimate.com/github/de-wiring/wire/Wire::Resource::OVSBridge
       # checks if the bridge exists
       def exist?
         LocalExecution.with(@executables[:vsctl],

data/lib/wire/resource/network_injection.rb

@@ -24,16 +24,21 @@ module Wire
       # names of networks to attach appgroup containers to
       attr_accessor :networks
 
+      # filename of state file
+      attr_accessor :statefile
+
       # initialize the object with
       # given appgroup +name+ and +container+ ids
       # params:
       # ++name++: Application group name
-      # ++networks++: [Array] of network names to attach containers to
-      # ++containers+: [Array] of container ids (i.e. from fig ps -q)
-      def initialize(name, networks, containers)
+      # ++networks++: [Array] of network objects to attach containers to
+      # ++containers++: [Array] of container ids (i.e. from fig ps -q)
+      # ++statefile++: Optional name of (network) statefile
+      def initialize(name, networks, containers, statefile = nil)
         super(name)
         self.containers = containers
         self.networks = networks
+        self.statefile = statefile
 
         begin
           # try to locate the gem base path and find shell script
@@ -73,12 +78,18 @@ module Wire
       # an array of container devices names and bridge names,
       # i.e. eht1:br0 meaning container will be attached
       # to bridge br0 with eth1.
-      # first iteration: choose device=network_name=bridge_name,
-      # all the same.
+      # if a network defines a short name, it will be used for
+      # the container interface.
+      # will check if a network does not have dhcp enable and add a
+      # NODHCP flag.
       def construct_helper_params
         res = []
-        networks.each do |network|
-          res << "#{network}:#{network}"
+        networks.each do |network_name, network_data|
+          name = (network_data[:shortname]) ? network_data[:shortname] : network_name
+
+          line = "#{name}:#{network_name}"
+          (network_data[:dhcp]) || line << ':NODHCP'
+          res << line
         end
         res.join(' ')
       end
@@ -93,17 +104,23 @@ module Wire
         end
       end
 
-      # attaches containers to networks
-      def up
-        $log.debug 'Attaching containers to networks ...'
-        with_helper('attach', [construct_helper_params,
-                               containers.join(' ')]) do |exec_obj|
+      # Params:
+      # ++cmd++: One of :attach, :detach
+      def updown_command(cmd)
+        $log.debug "About to #{cmd.to_s.capitalize} containers to networks ..."
+        statefile_param = (@statefile) ? "-s #{@statefile}" : ''
+        with_helper(cmd.to_s, [construct_helper_params,
+                               containers.join(' ')], statefile_param) do |exec_obj|
           exec_obj.run
-
           return (exec_obj.exitstatus == 0 && count_errors(exec_obj) == 0)
         end
       end
 
+      # attaches containers to networks
+      def up
+        updown_command :attach
+      end
+
       # checks if the bridge is down
       def down?
         !(up?)
@@ -111,13 +128,7 @@ module Wire
 
       # detaches network interfaces form containers and bridges
       def down
-        $log.debug 'Taking down container network attachments ...'
-        with_helper('detach', [construct_helper_params,
-                               containers.join(' ')]) do |exec_obj|
-          exec_obj.run
-
-          return (exec_obj.exitstatus == 0 && count_errors(exec_obj) == 0)
-        end
+        updown_command :detach
       end
 
       # Returns a string representation

data/lib/wire/resource/resource.rb

@@ -26,11 +26,11 @@ module Wire
     end
 
     # ResourceFactory creates Resource objects
-    # given by name
+    # given by symbolic name
     class ResourceFactory
       include Singleton
 
-      # given a +resource_name+ as a symbol (i.e. :ovsbridge)
+      # given a +resource_symname+ as a symbol (i.e. :ovsbridge)
       # this creates a resource with given name (i.e. "testbridge")
       # and hands on arguments (+resource_nameargs+, may be 1..n)
       # returns

data/lib/wire/version.rb

@@ -9,6 +9,6 @@ module Wire
   # Wire Version information
   module WireVersion
     # current version
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dewiring
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Andreas Schmidt