smart_proxy_dns_powerdns 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6aef9bd6276d31444fab893bb884ccc663820cba
-  data.tar.gz: e17f14a05adef3c63ec53c0d8f131a3668f962dd
+SHA256:
+  metadata.gz: 91fabd73d9aa9962f5117f82375dbf50ebd42f1535ab1162b18f5af6eccb20a1
+  data.tar.gz: ebcaed367e7e65a911d8711e881ff9471e7ef731015cf4c7935ba330b8f464ea
 SHA512:
-  metadata.gz: ebf9237f705434eec15aa56008f4819270e7134816433fba310da2b5daa80574a7065f249fd848b32f612dc12a87917f14f6e9eb0743751b83dfa79c16252ca7
-  data.tar.gz: 4aae6514df432f499f87998e9c84a0ec1b4964146073bb9b59d60770d3f058b7d0cc8636762d0c7868bde48c674d1797c474c87a54069e2c1ac15938adbcb386
+  metadata.gz: 49e9f311cc142d0daf1ff414d715c52950e4ff3d599c267fae33932648aa8578fbd2b1ce8e298c4d4425e7d60e6dcc69b9c63a98d3fff2c3107558914af87c53
+  data.tar.gz: d21fc640d1f82569fa90718912ebca748c17a66caef9ba8966cb1c1e65a01179a0eea692e9f4f727e215577bb1143b58ad32a49f82b6cb2086b2573a9571fbee

data/README.md

@@ -8,10 +8,10 @@ This plugin adds a new DNS provider for managing records in PowerDNS.
 
 ## Installation
 
-See [How_to_Install_a_Smart-Proxy_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Smart-Proxy_Plugin)
+See [How\_to\_Install\_a\_Smart-Proxy\_Plugin](https://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Smart-Proxy_Plugin)
 for how to install Smart Proxy plugins
 
-This plugin is compatible with Smart Proxy 1.13 or higher.
+This plugin is compatible with Smart Proxy 1.15 or higher.
 
 When installing using "gem", make sure to install the bundle file:
 
@@ -19,6 +19,11 @@ When installing using "gem", make sure to install the bundle file:
 
 ## Upgrading
 
+### 0.4.0
+
+* The minimum Smart Proxy version is now 1.15
+* The MySQL and PostgreSQL backends are officially deprecated and will be removed in the next release.
+
 ### 0.3.0
 
 * The minimum Smart Proxy version is now 1.13
@@ -44,7 +49,11 @@ To use the REST backend, set the following parameters:
     :powerdns_rest_url: 'http://localhost:8081/api/v1/servers/localhost'
     :powerdns_rest_api_key: 'apikey'
 
-Note the API is only tested with 4.x. Older versions may work, but they can also break.
+**Note** only API v1 from PowerDNS 4.x is supported. The v0 API from 3.x is unsupported.
+
+### DNSSEC with REST
+
+Domains in PowerDNS need a rectify action after modification. In the past this was done using pdnsutil (which can still be set) but since PowerDNS 4.1.0 the API can do this automatically. The [domain metadata API-RECTIFY](https://doc.powerdns.com/authoritative/domainmetadata.html#metadata-api-rectify) needs to be set to `1`. When it's unset, the config variable [default-api-rectify](https://doc.powerdns.com/authoritative/settings.html#setting-default-api-rectify) will be used. PowerDNS 4.2.0 started to default to true. When this is used, the value for `:powerdns_pdnssec` in this plugin should be empty (default).
 
 ### MySQL
 
@@ -56,6 +65,8 @@ To use MySQL, set the following parameters:
     :powerdns_mysql_password: ''
     :powerdns_mysql_database: 'powerdns'
 
+**Note** use of this backend is deprecated. REST should be used.
+
 ### PostgreSQL
 
 To use PostgreSQL, set the following parameters:
@@ -63,17 +74,45 @@ To use PostgreSQL, set the following parameters:
     :powerdns_backend: 'postgresql'
     :powerdns_postgresql_connection: 'host=localhost user=powerdns password=mypassword dbname=powerdns'
 
+**Note** use of this backend is deprecated. REST should be used.
+
 ### DNSSEC with MySQL and PostgreSQL
 
 In case you've enabled DNSSEC (as you should), all database backends require a rectify-zone after every zone change. The REST backend ignores this setting. The pdnssec command is configurable:
 
-    :powerdns_pdnssec: 'pdnssec'
+    :powerdns_pdnssec: 'pdnsutil'
 
 Or a more complex example:
 
-    :powerdns_pdnssec: 'sudo pdnssec --config-name=myconfig'
+    :powerdns_pdnssec: 'sudo pdnsutil --config-name=myconfig'
+
+Note that PowerDNS 3.x used `pdnssec` rather than `pdnsutil` which explains the naming of the option.
+
+### SOA autoserial with MySQL and PostgreSQL
+
+PowerDNS (>= 3.3) provides a feature called `autoserial` that takes care of managing the serial of `SOA` records.
+
+There are many options available regarding how PowerDNS generates the serial and details can be found looking for the `SOA-EDIT` option in PowerDNS.
+
+One option is to let the PowerDNS backend determine the `SOA` serial using the biggest `change_date` of the records associated with the DNS domain.
+`smart_proxy_dns_powerdns` uses this approach and updates the `change_date` field of changed records, setting them to the current timestamp of the database server, represented as **the number of seconds since EPOCH**.
+
+* when a new record is created, its `change_date` is set accordingly
+* when a record is deleted, the `change_date` of the `SOA` record for the domain is updated
+
+### Updating the SOA serial when using the REST backend
+
+When using the REST backend, the `change_date` of records isn't modified by this plugin.  To automatically increment the serial number of a zone, you can configure the [SOA-EDIT-API](https://doc.powerdns.com/authoritative/domainmetadata.html#soa-edit-api) zone metadata.  For example:
+
+```shell
+pdnsutil set-meta example.com SOA-EDIT-API DEFAULT
+```
+
+Other methods for managing the serial number are also available.  Alternatives to `SOA-EDIT-API` you might want to investigate include:
+  * Installing database triggers that update the SOA record.
+  * Reconfiguring powerdns's prepared statements such that the `change\_date` column gets updated when records are updated.
 
-Note that PowerDNS 4.x now uses `pdnsutil` rather than `pdnssec`.
+Full discussion of these methods is beyond the scope of this README.
 
 ## Contributing
 
@@ -94,7 +133,7 @@ Then run the tests:
 
 ## Copyright
 
-Copyright (c) 2015 - 2016 Ewoud Kohl van Wijngaarden
+Copyright (c) 2015 - 2019 Ewoud Kohl van Wijngaarden
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -107,5 +146,5 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
 

data/lib/smart_proxy_dns_powerdns/backend/mysql.rb

@@ -26,7 +26,7 @@ module Proxy::Dns::Powerdns::Backend
         domain = row
       end
 
-      raise Proxy::Dns::Error, "Unable to determine zone. Zone must exist in PowerDNS." unless domain
+      raise Proxy::Dns::Error, "Unable to determine zone for #{name}. Zone must exist in PowerDNS." unless domain
 
       domain
     end
@@ -35,7 +35,7 @@ module Proxy::Dns::Powerdns::Backend
       name = connection.escape(name)
       content = connection.escape(content)
       type = connection.escape(type)
-      connection.query("INSERT INTO records (domain_id, name, ttl, content, type) VALUES (#{domain_id}, '#{name}', #{ttl.to_i}, '#{content}', '#{type}')")
+      connection.query("INSERT INTO records (domain_id, name, ttl, content, type, change_date) VALUES (#{domain_id}, '#{name}', #{ttl.to_i}, '#{content}', '#{type}', UNIX_TIMESTAMP())")
       connection.affected_rows == 1
     end
 
@@ -43,7 +43,16 @@ module Proxy::Dns::Powerdns::Backend
       name = connection.escape(name)
       type = connection.escape(type)
       connection.query("DELETE FROM records WHERE domain_id=#{domain_id} AND name='#{name}' AND type='#{type}'")
-      connection.affected_rows >= 1
+      return false if connection.affected_rows == 0
+
+      connection.query("UPDATE records SET change_date=UNIX_TIMESTAMP() WHERE domain_id=#{domain_id} AND type='SOA'")
+      affected_rows = connection.affected_rows
+      if affected_rows > 1
+        logger.warning("Updated multiple SOA records (host=#{name}, domain_id=#{domain_id}). Check your zone records for duplicate SOA entries.")
+      elsif affected_rows == 0
+        logger.info("No SOA record updated (host=#{name}, domain_id=#{domain_id}). This can be caused by either a missing SOA record for the zone or consecutive updates of the same zone during the same second.")
+      end
+      true
     end
   end
 end

data/lib/smart_proxy_dns_powerdns/backend/postgresql.rb

@@ -24,19 +24,28 @@ module Proxy::Dns::Powerdns::Backend
         end
       end
 
-      raise Proxy::Dns::Error, "Unable to determine zone. Zone must exist in PowerDNS." unless domain
+      raise Proxy::Dns::Error, "Unable to determine zone for #{name}. Zone must exist in PowerDNS." unless domain
 
       domain
     end
 
     def create_record domain_id, name, type, content
-      result = connection.exec_params("INSERT INTO records (domain_id, name, ttl, content, type) VALUES ($1::int, $2, $3::int, $4, $5)", [domain_id, name, ttl, content, type])
+      result = connection.exec_params("INSERT INTO records (domain_id, name, ttl, content, type, change_date) VALUES ($1::int, $2, $3::int, $4, $5, extract(epoch from now()))", [domain_id, name, ttl, content, type])
       result.cmdtuples == 1
     end
 
     def delete_record domain_id, name, type
       result = connection.exec_params("DELETE FROM records WHERE domain_id=$1::int AND name=$2 AND type=$3", [domain_id, name, type])
-      result.cmdtuples >= 1
+      return false if result.cmdtuples == 0
+
+      result = connection.exec_params("UPDATE records SET change_date=extract(epoch from now()) WHERE domain_id=$1::int AND type='SOA'", [domain_id])
+      affected_rows = result.cmdtuples
+      if affected_rows > 1
+        logger.warning("Updated multiple SOA records (host=#{name}, domain_id=#{domain_id}). Check your zone records for duplicate SOA entries.")
+      elsif affected_rows == 0
+        logger.info("No SOA record updated (host=#{name}, domain_id=#{domain_id}). This can be caused by either a missing SOA record for the zone or consecutive updates of the same zone during the same second.")
+      end
+      true
     end
   end
 end

data/lib/smart_proxy_dns_powerdns/backend/rest.rb

@@ -33,7 +33,7 @@ module Proxy::Dns::Powerdns::Backend
         }.max_by { |zone| zone['name'].length }
       end
 
-      raise Proxy::Dns::Error, "Unable to determine zone. Zone must exist in PowerDNS." unless result
+      raise Proxy::Dns::Error, "Unable to determine zone for #{name}. Zone must exist in PowerDNS." unless result
 
       result
     end

data/lib/smart_proxy_dns_powerdns/dns_powerdns_main.rb

@@ -13,85 +13,28 @@ module Proxy::Dns::Powerdns
       super(a_server, a_ttl)
     end
 
-    def create_a_record(fqdn, ip)
-      case a_record_conflicts(fqdn, ip)
-      when 1
-        raise(Proxy::Dns::Collision, "'#{fqdn} 'is already in use")
-      when 0 then
-        return nil
-      else
-        do_create(fqdn, ip, "A")
-      end
-    end
-
-    def create_aaaa_record(fqdn, ip)
-      case aaaa_record_conflicts(fqdn, ip)
-      when 1
-        raise(Proxy::Dns::Collision, "'#{fqdn} 'is already in use")
-      when 0 then
-        return nil
-      else
-        do_create(fqdn, ip, "AAAA")
-      end
-    end
-
-    def create_cname_record(fqdn, target)
-      case cname_record_conflicts(fqdn, target)
-      when 1 then
-        raise(Proxy::Dns::Collision, "'#{fqdn} 'is already in use")
-      when 0 then
-        return nil
-      else
-        do_create(fqdn, target, "CNAME")
-      end
-    end
-
-    def create_ptr_record(fqdn, ptr)
-      case ptr_record_conflicts(fqdn, ptr_to_ip(ptr))
-      when 1
-        raise(Proxy::Dns::Collision, "'#{fqdn} 'is already in use")
-      when 0 then
-        return nil
-      else
-        do_create(ptr, fqdn, "PTR")
-      end
-    end
-
     def do_create(name, value, type)
       zone = get_zone(name)
-      unless create_record(zone['id'], name, type, value) and rectify_zone(zone['name'])
-        raise Proxy::Dns::Error.new("Failed to create record #{name} #{type} #{value}")
+      if create_record(zone['id'], name, type, value)
+        raise Proxy::Dns::Error.new("Failed to rectify zone #{zone['name']}") unless rectify_zone(zone['name'])
+      else
+        raise Proxy::Dns::Error.new("Failed to insert record #{name} #{type} #{value}")
       end
       true
     end
 
-    def remove_a_record(fqdn)
-      do_remove(fqdn, "A")
-    end
-
-    def remove_aaaa_record(fqdn)
-      do_remove(fqdn, "AAAA")
-    end
-
-    def remove_cname_record(fqdn)
-      do_remove(fqdn, "CNAME")
-    end
-
-    def remove_ptr_record(ptr)
-      do_remove(ptr, "PTR")
-    end
-
     def do_remove(name, type)
       zone = get_zone(name)
       if delete_record(zone['id'], name, type)
-        raise Proxy::Dns::Error.new("Failed to remove record #{name} #{type}") unless rectify_zone(zone['name'])
+        raise Proxy::Dns::Error.new("Failed to rectify zone #{name}") unless rectify_zone(zone['name'])
       end
       true
     end
 
-    def get_zone(fqdn)
+    # :nocov:
+    def get_zone(name)
       # TODO: backend specific
-      raise Proxy::Dns::Error, "Unable to determine zone. Zone must exist in PowerDNS."
+      raise Proxy::Dns::Error, "Unable to determine zone for #{name}. Zone must exist in PowerDNS."
     end
 
     def create_record(domain_id, name, type, content)
@@ -103,12 +46,19 @@ module Proxy::Dns::Powerdns
       # TODO: backend specific
       false
     end
+    # :nocov:
 
     def rectify_zone domain
       if @pdnssec
-        %x(#{@pdnssec} rectify-zone "#{domain}")
-
-        $?.exitstatus == 0
+        logger.debug("running: #{@pdnssec} rectify-zone \"#{domain}\"")
+        pdnsout = %x(#{@pdnssec} rectify-zone "#{domain}" 2>&1)
+
+        if $?.exitstatus != 0
+          logger.debug("#{@pdnssec} (exit: #{$?.exitstatus}) says: #{pdnsout}")
+          false
+        else
+          true
+        end
       else
         true
       end

data/lib/smart_proxy_dns_powerdns/dns_powerdns_plugin.rb

@@ -5,7 +5,7 @@ module Proxy::Dns::Powerdns
   class Plugin < ::Proxy::Provider
     plugin :dns_powerdns, ::Proxy::Dns::Powerdns::VERSION
 
-    requires :dns, '>= 1.13'
+    requires :dns, '>= 1.15'
 
     validate_presence :powerdns_backend
 

data/lib/smart_proxy_dns_powerdns/dns_powerdns_version.rb

@@ -1,7 +1,7 @@
 module Proxy
   module Dns
     module Powerdns
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

data/test/unit/dns_powerdns_record_mysql_test.rb

@@ -39,19 +39,76 @@ class DnsPowerdnsBackendMysqlTest < Test::Unit::TestCase
     @connection.expects(:escape).with('test.example.com').returns('test.example.com')
     @connection.expects(:escape).with('A').returns('A')
     @connection.expects(:escape).with('10.1.1.1').returns('10.1.1.1')
-    @connection.expects(:query).with("INSERT INTO records (domain_id, name, ttl, content, type) VALUES (1, 'test.example.com', 86400, '10.1.1.1', 'A')")
+    @connection.expects(:query).with("INSERT INTO records (domain_id, name, ttl, content, type, change_date) VALUES (1, 'test.example.com', 86400, '10.1.1.1', 'A', UNIX_TIMESTAMP())")
     @connection.expects(:affected_rows).returns(1)
 
     assert @provider.create_record(1, 'test.example.com', 'A', '10.1.1.1')
   end
 
   def test_delete_record
-    @connection.expects(:escape).with('test.example.com').returns('test.example.com')
-    @connection.expects(:escape).with('A').returns('A')
-    @connection.expects(:query).with("DELETE FROM records WHERE domain_id=1 AND name='test.example.com' AND type='A'")
-    @connection.expects(:affected_rows).returns(1)
+    mock_escapes(fqdn, 'A')
+    @connection.expects(:query).with(query_delete)
+    @connection.expects(:query).with(query_update_soa)
+    @connection.expects(:affected_rows).twice.returns(1)
+    assert @provider.delete_record(domain_id, fqdn, 'A')
+  end
+
+  def test_delete_no_record
+    mock_escapes(fqdn, 'A')
+    @connection.expects(:query).with(query_delete)
+    @connection.expects(:affected_rows).returns(0)
+
+    assert_false @provider.delete_record(domain_id, fqdn, 'A')
+  end
+
+  def test_delete_record_no_soa
+    mock_escapes(fqdn, 'A')
+    @connection.expects(:query).with(query_delete)
+    @connection.expects(:query).with(query_update_soa)
+    @connection.expects(:affected_rows).twice.returns(1, 0)
+    logger = mock()
+    logger.expects(:info)
+    @provider.stubs(:logger).returns(logger)
+
+    assert @provider.delete_record(domain_id, fqdn, 'A')
+  end
+
+  def test_delete_record_multiple_soa
+    mock_escapes(fqdn, 'A')
+    @connection.expects(:query).with(query_delete)
+    @connection.expects(:query).with(query_update_soa)
+    @connection.expects(:affected_rows).twice.returns(1, 2)
+    logger = mock()
+    logger.expects(:warning)
+    @provider.stubs(:logger).returns(logger)
+
+    assert @provider.delete_record(domain_id, fqdn, 'A')
+  end
+
+  private
+
+  def mock_escapes(*elts)
+    elts.each { |e| @connection.expects(:escape).with(e).returns(e) }
+  end
+
+  def domain
+    'example.com'
+  end
+
+  def fqdn
+    "test.#{domain}"
+  end
+
+  def domain_id
+    1
+  end
+
+  def query_delete(type='A')
+    "DELETE FROM records WHERE domain_id=#{domain_id} AND name='#{fqdn}' AND type='#{type}'"
+  end
 
-    assert @provider.delete_record(1, 'test.example.com', 'A')
+  def query_update_soa
+    "UPDATE records SET change_date=UNIX_TIMESTAMP() WHERE domain_id=#{domain_id} AND type='SOA'"
   end
 
 end

data/test/unit/dns_powerdns_record_postgresql_test.rb

@@ -35,33 +35,91 @@ class DnsPowerdnsBackendPostgresqlTest < Test::Unit::TestCase
 
   def test_create_record
     @connection.expects(:exec_params).
-      with("INSERT INTO records (domain_id, name, ttl, content, type) VALUES ($1::int, $2, $3::int, $4, $5)", [1, 'test.example.com', 86400, '10.1.1.1', 'A']).
+      with("INSERT INTO records (domain_id, name, ttl, content, type, change_date) VALUES ($1::int, $2, $3::int, $4, $5, extract(epoch from now()))", [1, 'test.example.com', 86400, '10.1.1.1', 'A']).
       returns(mock(:cmdtuples => 1))
 
     assert_true @provider.create_record(1, 'test.example.com', 'A', '10.1.1.1')
   end
 
   def test_delete_record_no_records
-    @connection.expects(:exec_params).
-      with("DELETE FROM records WHERE domain_id=$1::int AND name=$2 AND type=$3", [1, 'test.example.com', 'A']).
-      returns(mock(:cmdtuples => 0))
-
-    assert_false @provider.delete_record(1, 'test.example.com', 'A')
+    mock_delete_tuples(0)
+    assert_false run_delete_record
   end
 
   def test_delete_record_single_record
-    @connection.expects(:exec_params).
-      with("DELETE FROM records WHERE domain_id=$1::int AND name=$2 AND type=$3", [1, 'test.example.com', 'A']).
-      returns(mock(:cmdtuples => 1))
+    mock_delete_tuples(1)
+    mock_update_soa_tuples(1)
 
-    assert_true @provider.delete_record(1, 'test.example.com', 'A')
+    assert_true run_delete_record
   end
 
   def test_delete_record_multiple_records
+    mock_delete_tuples(2)
+    mock_update_soa_tuples(1)
+
+    assert_true run_delete_record
+  end
+
+  def test_delete_record_no_soa
+    mock_delete_tuples(1)
+    mock_update_soa_tuples(0)
+    logger = mock()
+    logger.expects(:info)
+    @provider.stubs(:logger).returns(logger)
+
+    assert_true run_delete_record
+  end
+
+  def test_delete_record_multiple_soa
+    mock_delete_tuples(1)
+    mock_update_soa_tuples(2)
+    logger = mock()
+    logger.expects(:warning)
+    @provider.stubs(:logger).returns(logger)
+
+    assert_true run_delete_record
+  end
+
+  private
+
+  def mock_delete_tuples(cmdtuples)
     @connection.expects(:exec_params).
-      with("DELETE FROM records WHERE domain_id=$1::int AND name=$2 AND type=$3", [1, 'test.example.com', 'A']).
-      returns(mock(:cmdtuples => 2))
+      with(query_delete, [domain_id, fqdn, record_type]).
+      returns(mock(:cmdtuples => cmdtuples))
+  end
 
-    assert_true @provider.delete_record(1, 'test.example.com', 'A')
+  def mock_update_soa_tuples(cmdtuples)
+    @connection.expects(:exec_params).
+      with(query_update_soa, [domain_id]).
+      returns(mock(:cmdtuples => cmdtuples))
   end
+
+  def run_delete_record
+    @provider.delete_record(domain_id, fqdn, record_type)
+  end
+
+  def domain
+    'example.com'
+  end
+
+  def fqdn
+    "test.#{domain}"
+  end
+
+  def domain_id
+    1
+  end
+
+  def record_type
+    'A'
+  end
+
+  def query_delete
+    "DELETE FROM records WHERE domain_id=$1::int AND name=$2 AND type=$3"
+  end
+
+  def query_update_soa
+    "UPDATE records SET change_date=extract(epoch from now()) WHERE domain_id=$1::int AND type='SOA'"
+  end
+
 end

data/test/unit/dns_powerdns_record_test.rb

@@ -4,153 +4,39 @@ require 'smart_proxy_dns_powerdns/dns_powerdns_main'
 
 class DnsPowerdnsRecordTest < Test::Unit::TestCase
   def setup
-    @provider = Proxy::Dns::Powerdns::Record.new('localhost', 86400, 'sudo pdnssec')
+    @provider = Proxy::Dns::Powerdns::Record.new('localhost', 86400, 'echo pdnssec')
   end
 
   def test_initialize
     assert_equal 86400, @provider.ttl
-    assert_equal 'sudo pdnssec', @provider.pdnssec
+    assert_equal 'echo pdnssec', @provider.pdnssec
   end
 
-  # Test A record creation
-  def test_create_a
-    @provider.expects(:a_record_conflicts).with('test.example.com', '10.1.1.1').returns(-1)
+  def test_do_create_success
     @provider.expects(:get_zone).with('test.example.com').returns({'id' => 1, 'name' => 'example.com'})
     @provider.expects(:create_record).with(1, 'test.example.com', 'A', '10.1.1.1').returns(true)
     @provider.expects(:rectify_zone).with('example.com').returns(true)
 
-    assert @provider.create_a_record(fqdn, ipv4)
-  end
-
-  # Test A record creation does nothing if the same record exists
-  def test_create_a_duplicate
-    @provider.expects(:a_record_conflicts).with('test.example.com', '10.1.1.1').returns(0)
-
-    assert_equal nil, @provider.create_a_record(fqdn, ipv4)
-  end
-
-  # Test A record creation fails if the record exists
-  def test_create_a_conflict
-    @provider.expects(:a_record_conflicts).with('test.example.com', '10.1.1.1').returns(1)
-
-    assert_raise(Proxy::Dns::Collision) { @provider.create_a_record(fqdn, ipv4) }
-  end
-
-  # Test AAAA record creation
-  def test_create_aaaa
-    @provider.expects(:aaaa_record_conflicts).with('test.example.com', '2001:db8:1234:abcd::1').returns(-1)
-    @provider.expects(:get_zone).with('test.example.com').returns({'id' => 1, 'name' => 'example.com'})
-    @provider.expects(:create_record).with(1, 'test.example.com', 'AAAA', '2001:db8:1234:abcd::1').returns(true)
-    @provider.expects(:rectify_zone).with('example.com').returns(true)
-
-    assert @provider.create_aaaa_record(fqdn, ipv6)
-  end
-
-  # Test AAAA record creation does nothing if the same record exists
-  def test_create_aaaa_duplicate
-    @provider.expects(:aaaa_record_conflicts).with('test.example.com', '2001:db8:1234:abcd::1').returns(0)
-
-    assert_equal nil, @provider.create_aaaa_record(fqdn, ipv6)
-  end
-
-  # Test AAAA record creation fails if the record exists
-  def test_create_aaaa_conflict
-    @provider.expects(:aaaa_record_conflicts).with('test.example.com', '2001:db8:1234:abcd::1').returns(1)
-
-    assert_raise(Proxy::Dns::Collision) { @provider.create_aaaa_record(fqdn, ipv6) }
-  end
-
-  # Test CNAME record creation
-  def test_create_cname
-    @provider.expects(:cname_record_conflicts).with('test.example.com', 'something.example.com').returns(-1)
-    @provider.expects(:get_zone).with('test.example.com').returns({'id' => 1, 'name' => 'example.com'})
-    @provider.expects(:create_record).with(1, 'test.example.com', 'CNAME', 'something.example.com').returns(true)
-    @provider.expects(:rectify_zone).with('example.com').returns(true)
-
-    assert @provider.create_cname_record(fqdn, 'something.example.com')
-  end
-
-  # Test CNAME record creation does nothing if the same record exists
-  def test_create_cname_duplicate
-    @provider.expects(:cname_record_conflicts).with('test.example.com', 'something.example.com').returns(0)
-
-    assert_equal nil, @provider.create_cname_record(fqdn, 'something.example.com')
-  end
-
-  # Test CNAME record creation fails if the record exists
-  def test_create_cname_conflict
-    @provider.expects(:cname_record_conflicts).with('test.example.com', 'something.example.com').returns(1)
-
-    assert_raise(Proxy::Dns::Collision) { @provider.create_cname_record(fqdn, 'something.example.com') }
-  end
-
-  # Test PTR record creation
-  def test_create_ptr
-    @provider.expects(:ptr_record_conflicts).with('test.example.com', '10.1.1.1').returns(-1)
-    @provider.expects(:get_zone).with('1.1.1.10.in-addr.arpa').returns({'id' => 1, 'name' => '1.1.10.in-addr.arpa'})
-    @provider.expects(:create_record).with(1, '1.1.1.10.in-addr.arpa', 'PTR', 'test.example.com').returns(true)
-    @provider.expects(:rectify_zone).with('1.1.10.in-addr.arpa').returns(true)
-
-    assert @provider.create_ptr_record(fqdn, reverse_ipv4)
-  end
-
-  # Test PTR record creation does nothing if the same record exists
-  def test_create_ptr_duplicate
-    @provider.expects(:ptr_record_conflicts).with('test.example.com', '10.1.1.1').returns(0)
-
-    assert_equal nil, @provider.create_ptr_record(fqdn, reverse_ipv4)
-  end
-
-  # Test PTR record creation fails if the record exists
-  def test_create_ptr_conflict
-    @provider.expects(:ptr_record_conflicts).with('test.example.com', '10.1.1.1').returns(1)
-
-    assert_raise(Proxy::Dns::Collision) { @provider.create_ptr_record(fqdn, reverse_ipv4) }
-  end
-
-  # Test PTR record creation
-  def test_create_ptr_ipv6
-    @provider.expects(:ptr_record_conflicts).with('test.example.com', '2001:0db8:1234:abcd:0000:0000:0000:0001').returns(-1)
-    @provider.expects(:get_zone).with('1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa').returns({'id' => 1, 'name' => 'd.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa'})
-    @provider.expects(:create_record).with(1, '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa', 'PTR', 'test.example.com').returns(true)
-    @provider.expects(:rectify_zone).with('d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa').returns(true)
-
-    assert @provider.create_ptr_record(fqdn, reverse_ipv6)
+    assert @provider.do_create('test.example.com', '10.1.1.1', 'A')
   end
 
-  # Test A record removal
-  def test_remove_a
+  def test_do_create_failure_in_create
     @provider.expects(:get_zone).with('test.example.com').returns({'id' => 1, 'name' => 'example.com'})
-    @provider.expects(:delete_record).with(1, 'test.example.com', 'A').returns(true)
-    @provider.expects(:rectify_zone).with('example.com').returns(true)
-
-    assert @provider.remove_a_record(fqdn)
-  end
-
-  # Test PTR record removal
-  def test_remove_ptr_ipv4
-    @provider.expects(:get_zone).with('1.1.1.10.in-addr.arpa').returns({'id' => 1, 'name' => '1.1.10.in-addr.arpa'})
-    @provider.expects(:delete_record).with(1, '1.1.1.10.in-addr.arpa', 'PTR').returns(true)
-    @provider.expects(:rectify_zone).with('1.1.10.in-addr.arpa').returns(true)
-
-    assert @provider.remove_ptr_record(reverse_ipv4)
-  end
-
-  # Test PTR record removal
-  def test_remove_ptr_ipv6
-    @provider.expects(:get_zone).with('1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa').returns({'id' => 1, 'name' => 'd.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa'})
-    @provider.expects(:delete_record).with(1, '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa', 'PTR').returns(true)
-    @provider.expects(:rectify_zone).with('d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa').returns(true)
+    @provider.expects(:create_record).with(1, 'test.example.com', 'A', '10.1.1.1').returns(false)
 
-    assert @provider.remove_ptr_record(reverse_ipv6)
+    assert_raise(Proxy::Dns::Error) do
+      @provider.do_create('test.example.com', '10.1.1.1', 'A')
+    end
   end
 
-  def test_do_create
+  def test_do_create_failure_in_rectify
     @provider.expects(:get_zone).with('test.example.com').returns({'id' => 1, 'name' => 'example.com'})
     @provider.expects(:create_record).with(1, 'test.example.com', 'A', '10.1.1.1').returns(true)
-    @provider.expects(:rectify_zone).with('example.com').returns(true)
+    @provider.expects(:rectify_zone).with('example.com').returns(false)
 
-    assert @provider.do_create('test.example.com', '10.1.1.1', 'A')
+    assert_raise(Proxy::Dns::Error) do
+      @provider.do_create('test.example.com', '10.1.1.1', 'A')
+    end
   end
 
   def test_do_remove
@@ -161,25 +47,26 @@ class DnsPowerdnsRecordTest < Test::Unit::TestCase
     assert @provider.do_remove('test.example.com', 'A')
   end
 
-  private
+  def test_rectify_zone_success
+    @provider.logger.expects(:debug).with('running: echo pdnssec rectify-zone "example.com"')
 
-  def fqdn
-    'test.example.com'
+    assert_true @provider.rectify_zone 'example.com'
   end
 
-  def ipv4
-    '10.1.1.1'
-  end
+  def test_rectify_zone_failure
+    @provider = Proxy::Dns::Powerdns::Record.new('localhost', 86400, 'false')
 
-  def reverse_ipv4
-    '1.1.1.10.in-addr.arpa'
-  end
+    @provider.logger.expects(:debug).with('running: false rectify-zone "example.com"')
+    @provider.logger.expects(:debug).with('false (exit: 1) says: ')
 
-  def ipv6
-    '2001:db8:1234:abcd::1'
+    assert_false @provider.rectify_zone 'example.com'
   end
 
-  def reverse_ipv6
-    '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.d.c.b.a.4.3.2.1.8.b.d.0.1.0.0.2.ip6.arpa'
+  def test_rectify_zone_no_pdnssec
+    @provider = Proxy::Dns::Powerdns::Record.new('localhost', 86400, nil)
+
+    @provider.logger.stubs(:debug).raises(Exception)
+
+    assert_true @provider.rectify_zone 'example.com'
   end
 end

data/test/unit/internal_api_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+require 'dns_common/dns_common'
+require 'smart_proxy_dns_powerdns'
+require 'smart_proxy_dns_powerdns/dns_powerdns_main'
+require "rack/test"
+require 'json'
+
+module Proxy::Dns
+  module DependencyInjection
+    include Proxy::DependencyInjection::Accessors
+    def container_instance; end
+  end
+end
+
+require 'dns/dns_api'
+
+ENV['RACK_ENV'] = 'test'
+
+class InternalApiTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    app = Proxy::Dns::Api.new
+    app.helpers.server = @server
+    app
+  end
+
+  def setup
+    @server = Proxy::Dns::Powerdns::Record.new('localhost', 3600)
+  end
+
+  def test_create_a_record
+    name = "test.com"
+    value = "192.168.33.33"
+    type = "A"
+    @server.expects(:do_create).with(name, value, type)
+    post '/', :fqdn => name, :value => value, :type => type
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_create_ptr_record
+    name = "test.com"
+    value = "33.33.168.192.in-addr.arpa"
+    type = "PTR"
+    @server.expects(:do_create).with(value, name, type)
+    post '/', :fqdn => name, :value => value, :type => type
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_delete_a_record
+    name = "test.com"
+    @server.expects(:do_remove).with(name, "A")
+    delete name
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_delete_ptr_record
+    name = "33.33.168.192.in-addr.arpa"
+    @server.expects(:do_remove).with(name, "PTR")
+    delete name
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_dns_powerdns
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ewoud Kohl van Wijngaarden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,9 +86,6 @@ files:
 - lib/smart_proxy_dns_powerdns/dns_powerdns_main.rb
 - lib/smart_proxy_dns_powerdns/dns_powerdns_plugin.rb
 - lib/smart_proxy_dns_powerdns/dns_powerdns_version.rb
-- test/config/smart-proxy-settings.d/dns.yml
-- test/config/smart-proxy-settings.d/dns_powerdns.yml
-- test/config/smart-proxy-settings.yml
 - test/integration/integration_test.rb
 - test/test_helper.rb
 - test/unit/dns_powerdns_configuration_test.rb
@@ -97,6 +94,7 @@ files:
 - test/unit/dns_powerdns_record_postgresql_test.rb
 - test/unit/dns_powerdns_record_rest_test.rb
 - test/unit/dns_powerdns_record_test.rb
+- test/unit/internal_api_test.rb
 homepage: https://github.com/theforeman/smart_proxy_dns_powerdns
 licenses:
 - GPL-3.0
@@ -116,20 +114,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: PowerDNS DNS provider plugin for Foreman's smart proxy
 test_files:
-- test/integration/integration_test.rb
-- test/unit/dns_powerdns_configuration_test.rb
-- test/unit/dns_powerdns_record_mysql_test.rb
 - test/unit/dns_powerdns_record_rest_test.rb
 - test/unit/dns_powerdns_record_test.rb
-- test/unit/dns_powerdns_record_dummy_test.rb
+- test/unit/dns_powerdns_record_mysql_test.rb
+- test/unit/dns_powerdns_configuration_test.rb
+- test/unit/internal_api_test.rb
 - test/unit/dns_powerdns_record_postgresql_test.rb
-- test/config/smart-proxy-settings.d/dns.yml
-- test/config/smart-proxy-settings.d/dns_powerdns.yml
-- test/config/smart-proxy-settings.yml
+- test/unit/dns_powerdns_record_dummy_test.rb
 - test/test_helper.rb
+- test/integration/integration_test.rb

data/test/config/smart-proxy-settings.d/dns.yml

@@ -1,3 +0,0 @@
----
-:enabled: true
-:use_provider: dns_powerdns

data/test/config/smart-proxy-settings.d/dns_powerdns.yml

@@ -1,4 +0,0 @@
----
-:powerdns_backend: rest
-:powerdns_rest_url: http://localhost:8081/api/v1/servers/localhost
-:powerdns_rest_api_key: apikey

data/test/config/smart-proxy-settings.yml

@@ -1,4 +0,0 @@
-:settings_directory: /home/ekohl/dev/smart_proxy_dns_powerdns/test/config/smart-proxy-settings.d
-:http_port: 8000
-:log_file: STDOUT
-:log_level: DEBUG