smart_proxy_dns_dnsmasq 0.4

data/lib/smart_proxy_dns_dnsmasq/dns_dnsmasq_plugin.rb

@@ -0,0 +1,25 @@
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_version'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_configuration'
+
+module Proxy::Dns::Dnsmasq
+  class Plugin < ::Proxy::Provider
+    plugin :dns_dnsmasq, ::Proxy::Dns::Dnsmasq::VERSION
+
+    # Settings listed under default_settings are required.
+    # An exception will be raised if they are initialized with nil values.
+    # Settings not listed under default_settings are considered optional and by default have nil value.
+    default_settings :config_path => '/etc/dnsmasq.d/foreman.conf',
+                     :reload_cmd => 'systemctl reload dnsmasq'
+
+    requires :dns, '>= 1.15'
+
+    # Verifies that a file exists and is readable.
+    # Uninitialized optional settings will not trigger validation errors.
+    validate_readable :config_path
+
+    # Loads plugin files and dependencies
+    load_classes ::Proxy::Dns::Dnsmasq::PluginConfiguration
+    # Loads plugin dependency injection wirings
+    load_dependency_injection_wirings ::Proxy::Dns::Dnsmasq::PluginConfiguration
+  end
+end

data/lib/smart_proxy_dns_dnsmasq/dns_dnsmasq_version.rb

@@ -0,0 +1,7 @@
+module Proxy
+  module Dns
+    module Dnsmasq
+      VERSION = '0.4'
+    end
+  end
+end

data/test/dns_dnsmasq_default_settings_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_configuration'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_plugin'
+
+class DnsDnsmasqDefaultSettingsTest < Test::Unit::TestCase
+  def test_default_settings
+    Proxy::Dns::Dnsmasq::Plugin.load_test_settings({})
+    assert_equal "default_value", Proxy::Dns::Dnsmasq::Plugin.settings.required_setting
+    assert_equal "/must/exist", Proxy::Dns::Dnsmasq::Plugin.settings.required_path
+  end
+end

data/test/dns_dnsmasq_production_wiring_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_configuration'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_main'
+
+class DnsDnsmasqProductionWiringTest < Test::Unit::TestCase
+  def setup
+    @container = ::Proxy::DependencyInjection::Container.new
+    @config = ::Proxy::Dns::Dnsmasq::PluginConfiguration.new
+  end
+
+  def test_dns_provider_initialization_default
+    @config.load_dependency_injection_wirings(@container, :dns_ttl => 999,
+                                              :config_path => '/etc/dnsmasq.conf',
+                                              :reload_cmd => 'systemctl reload dnsmasq')
+
+    provider = @container.get_dependency(:dns_provider)
+
+    assert_not_nil provider
+    assert_equal provider.class, Proxy::Dns::Dnsmasq::Default
+    assert_equal '/etc/dnsmasq.conf', provider.config_file
+    assert_equal 'systemctl reload dnsmasq', provider.reload_cmd
+    assert_equal 999, provider.ttl
+  end
+
+  def test_dns_provider_initialization
+    @config.load_dependency_injection_wirings(@container, :dns_ttl => 999,
+                                              :backend => 'openwrt',
+                                              :config_path => '/etc/config/dhcp',
+                                              :reload_cmd => '/etc/init.d/dnsmasq reload')
+
+    provider = @container.get_dependency(:dns_provider)
+
+    assert_not_nil provider
+    assert_equal provider.class, Proxy::Dns::Dnsmasq::Openwrt
+    assert_equal '/etc/config/dhcp', provider.config_file
+    assert_equal '/etc/init.d/dnsmasq reload', provider.reload_cmd
+    assert_equal 999, provider.ttl
+  end
+end

data/test/dns_dnsmasq_record_default_test.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_main'
+require 'smart_proxy_dns_dnsmasq/backend/default'
+
+class DnsDnsmasqRecordDefaultTest < Test::Unit::TestCase
+  def setup
+    @provider = Proxy::Dns::Dnsmasq::Default.new('/etc/dnsmasq.d/foreman.conf', 'systemctl reload dnsmasq', 999)
+
+    @provider.expects(:update!).returns(true)
+    @configuration = mock()
+    @provider.stubs(:configuration).returns(@configuration)
+  end
+
+  # Test A record creation
+  def test_create_a
+    fqdn = 'test.example.com'
+    ip = '10.1.1.1'
+
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Default::AddressEntry) &&
+      val.fqdn == [fqdn] &&
+      val.ip == ip
+    }.returns(true)
+    assert @provider.do_create(fqdn, ip, 'A')
+  end
+
+  # Test AAAA record creation
+  def test_create_aaaa
+    fqdn = 'test.example.com'
+    ip = '2001:db8::1'
+
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Default::AddressEntry) &&
+      val.fqdn == [fqdn] &&
+      val.ip == ip
+    }.returns(true)
+    assert @provider.do_create(fqdn, ip, 'AAAA')
+  end
+
+  # Test PTR record creation with an IPv4 address
+  def test_create_ptr_v4
+    fqdn = 'test.example.com'
+    ip = '3.2.1.10.in-addr.arpa'
+
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Default::PTREntry) &&
+      val.fqdn == fqdn &&
+      val.ip == ip
+    }.returns(true)
+    assert @provider.do_create(ip, fqdn, 'PTR')
+  end
+
+  # Test PTR record creation with an IPv6 address
+  def test_create_ptr_v6
+    fqdn = 'test.example.com'
+    ip = '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa' 
+
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Default::PTREntry) &&
+      val.fqdn == fqdn &&
+      val.ip == ip
+    }.returns(true)
+    assert @provider.do_create(ip, fqdn, 'PTR')
+  end
+
+  # Test CNAME record creation
+  def test_create_cname
+    name = 'test.example.com'
+    target = 'target.example.com'
+
+    @configuration.expects(:find).returns(nil)
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Default::CNAMEEntry) &&
+      val.name == name &&
+      val.target == target
+    }.returns(true)
+    assert @provider.do_create(name, target, 'CNAME')
+  end
+
+  # Test A record removal
+  def test_remove_a
+    @configuration.expects(:find).returns(Proxy::Dns::Dnsmasq::Default::AddressEntry.new)
+    @configuration.expects(:delete).with { |v| v.is_a? Proxy::Dns::Dnsmasq::Default::AddressEntry }.returns(true)
+    assert @provider.do_remove('test.example.com', 'A')
+  end
+
+  # Test AAAA record removal
+  def test_remove_aaaa
+    @configuration.expects(:find).returns(Proxy::Dns::Dnsmasq::Default::AddressEntry.new)
+    @configuration.expects(:delete).with { |v| v.is_a? Proxy::Dns::Dnsmasq::Default::AddressEntry }.returns(true)
+    assert @provider.do_remove('test.example.com', 'AAAA')
+  end
+
+  # Test PTR record removal with an IPv4 address
+  def test_remove_ptr_v4
+    @configuration.expects(:find).returns(Proxy::Dns::Dnsmasq::Default::PTREntry.new)
+    @configuration.expects(:delete).with { |v| v.is_a? Proxy::Dns::Dnsmasq::Default::PTREntry }.returns(true)
+    assert @provider.do_remove('3.2.1.10.in-addr.arpa', 'PTR')
+  end
+
+  # Test PTR record removal with an IPv6 address
+  def test_remove_ptr_v6
+    @configuration.expects(:find).returns(Proxy::Dns::Dnsmasq::Default::PTREntry.new)
+    @configuration.expects(:delete).with { |v| v.is_a? Proxy::Dns::Dnsmasq::Default::PTREntry }.returns(true)
+    assert @provider.do_remove('1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa', 'PTR')
+  end
+
+  # Test CNAME record removal
+  def test_remove_cname
+    @configuration.expects(:find).returns(Proxy::Dns::Dnsmasq::Default::CNAMEEntry.new)
+    @configuration.expects(:delete).with { |v| v.is_a? Proxy::Dns::Dnsmasq::Default::CNAMEEntry }.returns(true)
+    assert @provider.do_remove('test.example.com', 'CNAME')
+  end
+end

data/test/dns_dnsmasq_record_openwrt_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+require 'smart_proxy_dns_dnsmasq/dns_dnsmasq_main'
+require 'smart_proxy_dns_dnsmasq/backend/openwrt'
+
+class DnsDnsmasqRecordOpenwrtTest < Test::Unit::TestCase
+  def setup
+    @provider = Proxy::Dns::Dnsmasq::Openwrt.new('/etc/config/dhcp', '/etc/init.d/dnsmasq reload', 999)
+
+    @provider.expects(:update!).returns(true)
+    @configuration = mock()
+    @provider.stubs(:configuration).returns(@configuration)
+  end
+
+  # Test A record creation
+  def test_create_a
+    @provider.expects(:find_type).with(:domain, :name, 'test.example.com').returns(false)
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config) &&
+      val.type == :domain &&
+      val.options[:name] == 'test.example.com' &&
+      val.options[:ip] == '10.1.1.1'
+    }.returns(true)
+    assert @provider.do_create('test.example.com', '10.1.1.1', 'A')
+  end
+
+  # Test PTR record creation with an IPv4 address
+  def test_create_ptr_v4
+    @provider.expects(:find_type).with(:domain, :name, 'test.example.com').returns(false)
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config) &&
+      val.type == :domain &&
+      val.options[:name] == 'test.example.com' &&
+      val.options[:ip] == '10.1.2.3'
+    }.returns(true)
+    assert @provider.do_create('3.2.1.10.in-addr.arpa', 'test.example.com', 'PTR')
+  end
+
+  # Test CNAME record creation
+  def test_create_cname
+    @provider.expects(:find_type).with(:cname, :name, 'test.example.com').returns(false)
+    @configuration.expects(:<<).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config) &&
+      val.type == :cname &&
+      val.options[:cname] == 'test.example.com' &&
+      val.options[:target] == 'target.example.com'
+    }.returns(true)
+    assert @provider.do_create('test.example.com', 'target.example.com', 'CNAME')
+  end
+
+  # Test A record removal
+  def test_remove_a
+    @provider.expects(:find_type).with(:domain, :name, 'test.example.com').returns(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config.new(:domain))
+    @configuration.expects(:delete).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config) &&
+      val.type == :domain
+    }.returns(true)
+    assert @provider.do_remove('test.example.com', 'A')
+  end
+
+  # Test PTR record removal with an IPv4 address
+  def test_remove_ptr_v4
+    @provider.expects(:find_type).with(:domain, :ip, '10.1.2.3').returns(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config.new(:domain))
+    @configuration.expects(:delete).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config) &&
+      val.type == :domain
+    }.returns(true)
+    assert @provider.do_remove('3.2.1.10.in-addr.arpa', 'PTR')
+  end
+
+  # Test CNAME record removal
+  def test_remove_cname
+    @provider.expects(:find_type).with(:cname, :name, 'test.example.com').returns(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config.new(:cname))
+    @configuration.expects(:delete).with { |val|
+      val.is_a?(Proxy::Dns::Dnsmasq::Openwrt::DSL::Config) &&
+      val.type == :cname
+    }.returns(true)
+    assert @provider.do_remove('test.example.com', 'CNAME')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'mocha/setup'
+require 'json'
+require 'ostruct'
+
+require 'smart_proxy_for_testing'
+
+# create log directory in our (not smart-proxy) directory
+FileUtils.mkdir_p File.dirname(Proxy::SETTINGS.log_file)

data/test/testdata.openwrt

@@ -0,0 +1,43 @@
+
+config dnsmasq
+        option domainneeded '1'
+        option boguspriv '1'
+        option localise_queries '1'
+        option rebind_protection '1'
+        option rebind_localhost '1'
+        option expandhosts '1'
+        option authoritative '1'
+        option readethers '1'
+        option leasefile '/tmp/dhcp.leases'
+        option resolvfile '/tmp/resolv.conf.auto'
+        option localservice '1'
+        option port '0'
+        option local '/introvert.software/'
+        option domain 'introvert.software'
+        option nonwildcard '0'
+
+config dhcp 'lan'
+        option interface 'lan'
+        option start '100'
+        option limit '150'
+        option leasetime '12h'
+        option dhcpv6 'server'
+        option ra 'server'
+        option ignore '0'
+        list dhcp_option '6,192.168.0.1'
+
+config dhcp 'wan'
+        option interface 'wan'
+        option ignore '1'
+
+config odhcpd 'odhcpd'
+        option maindhcp '0'
+        option leasefile '/tmp/hosts/odhcpd'
+        option leasetrigger '/usr/sbin/odhcpd-update'
+
+config host
+        option name 'Potatis'
+        option mac '01:02:03:04:05:06'
+        option ip '1.2.3.4'
+
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: smart_proxy_dns_dnsmasq
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Alexander Olofsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: dnamasq DNS provider plugin for Foreman's smart proxy
+email:
+- alexander.olofsson@liu.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bundler.d/dns_dnsmasq.rb
+- config/dns_dnsmasq.yml
+- lib/smart_proxy_dns_dnsmasq.rb
+- lib/smart_proxy_dns_dnsmasq/backend/default.rb
+- lib/smart_proxy_dns_dnsmasq/backend/openwrt.rb
+- lib/smart_proxy_dns_dnsmasq/dns_dnsmasq_configuration.rb
+- lib/smart_proxy_dns_dnsmasq/dns_dnsmasq_main.rb
+- lib/smart_proxy_dns_dnsmasq/dns_dnsmasq_plugin.rb
+- lib/smart_proxy_dns_dnsmasq/dns_dnsmasq_version.rb
+- test/dns_dnsmasq_default_settings_test.rb
+- test/dns_dnsmasq_production_wiring_test.rb
+- test/dns_dnsmasq_record_default_test.rb
+- test/dns_dnsmasq_record_openwrt_test.rb
+- test/test_helper.rb
+- test/testdata.openwrt
+homepage: https://github.com/ace13/smart_proxy_dns_dnsmasq
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: dnsmasq DNS provider plugin for Foreman's smart proxy
+test_files:
+- test/test_helper.rb
+- test/dns_dnsmasq_default_settings_test.rb
+- test/dns_dnsmasq_production_wiring_test.rb
+- test/testdata.openwrt
+- test/dns_dnsmasq_record_openwrt_test.rb
+- test/dns_dnsmasq_record_default_test.rb