mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-12-18 05:41:55 +03:00
8a9c6e8a02
Merge in DNS/adguard-home from 2271-cover-with-tests to master Updates #2271. Squashed commit of the following: commit db6440efe05171bc15367a2996521848ca348053 Merge: db7fa726bbf4c256c7
Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 19:23:09 2020 +0300 Merge branch 'master' into 2271-cover-with-tests commit db7fa726bb91b08ec7aaa6c0c818c88b5feb87cd Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 18:26:51 2020 +0300 all: clean dependencies sum commit b8dc6078c4bcc0de1b7e9073832de122f6fe38a4 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 16:46:00 2020 +0300 testutil: improve code quality commit 001b7194682b1f00aa54dc5a28236faed5a5b02d Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 16:29:49 2020 +0300 testutil: enhance functionality commit f6ccd91a4df6c56778eab8ae50e88e3818b20dd3 Merge: 43fa2eefb6358240e9
Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 15:57:37 2020 +0300 Merge branch 'master' into 2271-cover-with-tests commit 43fa2eefbc10ef361603cacc1ca12092b12a057a Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 14:55:15 2020 +0300 querylog: replace fake log with real in tests commit b95bee7565a14a02c80c78131b3ced224663dd8a Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Nov 16 12:38:59 2020 +0300 dnsfilter: replace thoughtless declaration with idiomatic one commit a210b1586092e7ae91a9e67c972fa2d2f6baded6 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri Nov 13 19:00:25 2020 +0300 all: refresh golibs dependencies commit 4ff97bd1ade6c80e274ff5716e44df4eba55bdd9 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri Nov 13 18:38:47 2020 +0300 all: remove std log commit 542dbda10fefce9f46d15489712b163d919b1291 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri Nov 13 13:46:39 2020 +0300 querylog: improve test logic and readability commit 796d402385925e8e62a1b4c7bf56e4ceec22418c Author: Eugene Burkov <e.burkov@adguard.com> Date: Thu Nov 12 19:06:42 2020 +0300 all: improve code quality commit e81894c11ef15b0453e8e5297f1349936a32f9dd Author: Eugene Burkov <e.burkov@adguard.com> Date: Thu Nov 12 18:32:30 2020 +0300 all: cover with tests commit 252d81fc8a50a91b02cf0f6f35cc22178a2a4d90 Author: Eugene Burkov <e.burkov@adguard.com> Date: Thu Nov 12 17:32:01 2020 +0300 all: cover with tests
266 lines
7.2 KiB
Go
266 lines
7.2 KiB
Go
package querylog
|
|
|
|
import (
|
|
"net"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/AdguardTeam/dnsproxy/proxyutil"
|
|
|
|
"github.com/AdguardTeam/AdGuardHome/internal/dnsfilter"
|
|
"github.com/AdguardTeam/AdGuardHome/internal/testutil"
|
|
"github.com/miekg/dns"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestMain(m *testing.M) {
|
|
testutil.DiscardLogOutput(m)
|
|
}
|
|
|
|
func prepareTestDir() string {
|
|
const dir = "./agh-test"
|
|
_ = os.RemoveAll(dir)
|
|
_ = os.MkdirAll(dir, 0755)
|
|
return dir
|
|
}
|
|
|
|
// Check adding and loading (with filtering) entries from disk and memory
|
|
func TestQueryLog(t *testing.T) {
|
|
conf := Config{
|
|
Enabled: true,
|
|
FileEnabled: true,
|
|
Interval: 1,
|
|
MemSize: 100,
|
|
}
|
|
conf.BaseDir = prepareTestDir()
|
|
defer func() { _ = os.RemoveAll(conf.BaseDir) }()
|
|
l := newQueryLog(conf)
|
|
|
|
// add disk entries
|
|
addEntry(l, "example.org", "1.1.1.1", "2.2.2.1")
|
|
// write to disk (first file)
|
|
_ = l.flushLogBuffer(true)
|
|
// start writing to the second file
|
|
_ = l.rotate()
|
|
// add disk entries
|
|
addEntry(l, "example.org", "1.1.1.2", "2.2.2.2")
|
|
// write to disk
|
|
_ = l.flushLogBuffer(true)
|
|
// add memory entries
|
|
addEntry(l, "test.example.org", "1.1.1.3", "2.2.2.3")
|
|
addEntry(l, "example.com", "1.1.1.4", "2.2.2.4")
|
|
|
|
// get all entries
|
|
params := newSearchParams()
|
|
entries, _ := l.search(params)
|
|
assert.Equal(t, 4, len(entries))
|
|
assertLogEntry(t, entries[0], "example.com", "1.1.1.4", "2.2.2.4")
|
|
assertLogEntry(t, entries[1], "test.example.org", "1.1.1.3", "2.2.2.3")
|
|
assertLogEntry(t, entries[2], "example.org", "1.1.1.2", "2.2.2.2")
|
|
assertLogEntry(t, entries[3], "example.org", "1.1.1.1", "2.2.2.1")
|
|
|
|
// search by domain (strict)
|
|
params = newSearchParams()
|
|
params.searchCriteria = append(params.searchCriteria, searchCriteria{
|
|
criteriaType: ctDomainOrClient,
|
|
strict: true,
|
|
value: "TEST.example.org",
|
|
})
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 1, len(entries))
|
|
assertLogEntry(t, entries[0], "test.example.org", "1.1.1.3", "2.2.2.3")
|
|
|
|
// search by domain (not strict)
|
|
params = newSearchParams()
|
|
params.searchCriteria = append(params.searchCriteria, searchCriteria{
|
|
criteriaType: ctDomainOrClient,
|
|
strict: false,
|
|
value: "example.ORG",
|
|
})
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 3, len(entries))
|
|
assertLogEntry(t, entries[0], "test.example.org", "1.1.1.3", "2.2.2.3")
|
|
assertLogEntry(t, entries[1], "example.org", "1.1.1.2", "2.2.2.2")
|
|
assertLogEntry(t, entries[2], "example.org", "1.1.1.1", "2.2.2.1")
|
|
|
|
// search by client IP (strict)
|
|
params = newSearchParams()
|
|
params.searchCriteria = append(params.searchCriteria, searchCriteria{
|
|
criteriaType: ctDomainOrClient,
|
|
strict: true,
|
|
value: "2.2.2.2",
|
|
})
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 1, len(entries))
|
|
assertLogEntry(t, entries[0], "example.org", "1.1.1.2", "2.2.2.2")
|
|
|
|
// search by client IP (part of)
|
|
params = newSearchParams()
|
|
params.searchCriteria = append(params.searchCriteria, searchCriteria{
|
|
criteriaType: ctDomainOrClient,
|
|
strict: false,
|
|
value: "2.2.2",
|
|
})
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 4, len(entries))
|
|
assertLogEntry(t, entries[0], "example.com", "1.1.1.4", "2.2.2.4")
|
|
assertLogEntry(t, entries[1], "test.example.org", "1.1.1.3", "2.2.2.3")
|
|
assertLogEntry(t, entries[2], "example.org", "1.1.1.2", "2.2.2.2")
|
|
assertLogEntry(t, entries[3], "example.org", "1.1.1.1", "2.2.2.1")
|
|
}
|
|
|
|
func TestQueryLogOffsetLimit(t *testing.T) {
|
|
conf := Config{
|
|
Enabled: true,
|
|
Interval: 1,
|
|
MemSize: 100,
|
|
}
|
|
conf.BaseDir = prepareTestDir()
|
|
defer func() { _ = os.RemoveAll(conf.BaseDir) }()
|
|
l := newQueryLog(conf)
|
|
|
|
// add 10 entries to the log
|
|
for i := 0; i < 10; i++ {
|
|
addEntry(l, "second.example.org", "1.1.1.1", "2.2.2.1")
|
|
}
|
|
// write them to disk (first file)
|
|
_ = l.flushLogBuffer(true)
|
|
// add 10 more entries to the log (memory)
|
|
for i := 0; i < 10; i++ {
|
|
addEntry(l, "first.example.org", "1.1.1.1", "2.2.2.1")
|
|
}
|
|
|
|
// First page
|
|
params := newSearchParams()
|
|
params.offset = 0
|
|
params.limit = 10
|
|
entries, _ := l.search(params)
|
|
assert.Equal(t, 10, len(entries))
|
|
assert.Equal(t, entries[0].QHost, "first.example.org")
|
|
assert.Equal(t, entries[9].QHost, "first.example.org")
|
|
|
|
// Second page
|
|
params.offset = 10
|
|
params.limit = 10
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 10, len(entries))
|
|
assert.Equal(t, entries[0].QHost, "second.example.org")
|
|
assert.Equal(t, entries[9].QHost, "second.example.org")
|
|
|
|
// Second and a half page
|
|
params.offset = 15
|
|
params.limit = 10
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 5, len(entries))
|
|
assert.Equal(t, entries[0].QHost, "second.example.org")
|
|
assert.Equal(t, entries[4].QHost, "second.example.org")
|
|
|
|
// Third page
|
|
params.offset = 20
|
|
params.limit = 10
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 0, len(entries))
|
|
}
|
|
|
|
func TestQueryLogMaxFileScanEntries(t *testing.T) {
|
|
conf := Config{
|
|
Enabled: true,
|
|
FileEnabled: true,
|
|
Interval: 1,
|
|
MemSize: 100,
|
|
}
|
|
conf.BaseDir = prepareTestDir()
|
|
defer func() { _ = os.RemoveAll(conf.BaseDir) }()
|
|
l := newQueryLog(conf)
|
|
|
|
// add 10 entries to the log
|
|
for i := 0; i < 10; i++ {
|
|
addEntry(l, "example.org", "1.1.1.1", "2.2.2.1")
|
|
}
|
|
// write them to disk (first file)
|
|
_ = l.flushLogBuffer(true)
|
|
|
|
params := newSearchParams()
|
|
params.maxFileScanEntries = 5 // do not scan more than 5 records
|
|
entries, _ := l.search(params)
|
|
assert.Equal(t, 5, len(entries))
|
|
|
|
params.maxFileScanEntries = 0 // disable the limit
|
|
entries, _ = l.search(params)
|
|
assert.Equal(t, 10, len(entries))
|
|
}
|
|
|
|
func TestQueryLogFileDisabled(t *testing.T) {
|
|
conf := Config{
|
|
Enabled: true,
|
|
FileEnabled: false,
|
|
Interval: 1,
|
|
MemSize: 2,
|
|
}
|
|
conf.BaseDir = prepareTestDir()
|
|
defer func() { _ = os.RemoveAll(conf.BaseDir) }()
|
|
l := newQueryLog(conf)
|
|
|
|
addEntry(l, "example1.org", "1.1.1.1", "2.2.2.1")
|
|
addEntry(l, "example2.org", "1.1.1.1", "2.2.2.1")
|
|
addEntry(l, "example3.org", "1.1.1.1", "2.2.2.1")
|
|
// the oldest entry is now removed from mem buffer
|
|
|
|
params := newSearchParams()
|
|
ll, _ := l.search(params)
|
|
assert.Equal(t, 2, len(ll))
|
|
assert.Equal(t, "example3.org", ll[0].QHost)
|
|
assert.Equal(t, "example2.org", ll[1].QHost)
|
|
}
|
|
|
|
func addEntry(l *queryLog, host, answerStr, client string) {
|
|
q := dns.Msg{}
|
|
q.Question = append(q.Question, dns.Question{
|
|
Name: host + ".",
|
|
Qtype: dns.TypeA,
|
|
Qclass: dns.ClassINET,
|
|
})
|
|
|
|
a := dns.Msg{}
|
|
a.Question = append(a.Question, q.Question[0])
|
|
answer := new(dns.A)
|
|
answer.Hdr = dns.RR_Header{
|
|
Name: q.Question[0].Name,
|
|
Rrtype: dns.TypeA,
|
|
Class: dns.ClassINET,
|
|
}
|
|
answer.A = net.ParseIP(answerStr)
|
|
a.Answer = append(a.Answer, answer)
|
|
res := dnsfilter.Result{
|
|
IsFiltered: true,
|
|
Rule: "SomeRule",
|
|
Reason: dnsfilter.ReasonRewrite,
|
|
ServiceName: "SomeService",
|
|
FilterID: 1,
|
|
}
|
|
params := AddParams{
|
|
Question: &q,
|
|
Answer: &a,
|
|
OrigAnswer: &a,
|
|
Result: &res,
|
|
ClientIP: net.ParseIP(client),
|
|
Upstream: "upstream",
|
|
}
|
|
l.Add(params)
|
|
}
|
|
|
|
func assertLogEntry(t *testing.T, entry *logEntry, host, answer, client string) bool {
|
|
assert.Equal(t, host, entry.QHost)
|
|
assert.Equal(t, client, entry.IP)
|
|
assert.Equal(t, "A", entry.QType)
|
|
assert.Equal(t, "IN", entry.QClass)
|
|
|
|
msg := new(dns.Msg)
|
|
assert.Nil(t, msg.Unpack(entry.Answer))
|
|
assert.Equal(t, 1, len(msg.Answer))
|
|
ip := proxyutil.GetIPFromDNSRecord(msg.Answer[0])
|
|
assert.NotNil(t, ip)
|
|
assert.Equal(t, answer, ip.String())
|
|
return true
|
|
}
|