@adguard/hostlist-compiler 1.0.35 → 1.0.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/README.md +49 -0
- package/package.json +3 -2
- package/src/compile-source.js +2 -3
- package/src/filter.js +2 -2
- package/src/utils.js +0 -33
- package/test/compile-source.test.js +21 -8
- package/test/index.test.js +6 -2
- package/test/resolve-include.test.js +201 -0
- package/test/resources/includedfile.txt +2 -0
- package/test/resources/rules.txt +4 -0
- package/test/transformations/exclude.test.js +12 -4
- package/test/transformations/include.test.js +12 -4
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.0.37] - 2025-02-28
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Resolving the `!#include `directive by using `@adguard/filters-downloader`. [#78]
|
|
13
|
+
|
|
14
|
+
[1.0.37]: https://github.com/AdguardTeam/HostlistCompiler/compare/v1.0.35...v1.0.37
|
|
15
|
+
[#78]: https://github.com/AdguardTeam/HostlistCompiler/issues/78
|
|
16
|
+
|
|
8
17
|
## [1.0.35] - 2025-02-07
|
|
9
18
|
|
|
10
19
|
### Added
|
package/README.md
CHANGED
|
@@ -152,6 +152,55 @@ Please note, that exclusion or inclusion rules may be a plain string, wildcard,
|
|
|
152
152
|
- `/regex/` - every rule that matches this regular expression, will match the rule. By default, regular expressions are case-insensitive.
|
|
153
153
|
- `! comment` - comments will be ignored.
|
|
154
154
|
|
|
155
|
+
> [!IMPORTANT]
|
|
156
|
+
> Ensure that rules in the exclusion list match the format of the rules in the filter list.
|
|
157
|
+
> To maintain a consistent format, add the `Compress` transformation to convert `/etc/hosts` rules to adblock syntax.
|
|
158
|
+
> This is especially useful if you have multiple lists in different formats.
|
|
159
|
+
|
|
160
|
+
Here is an example:
|
|
161
|
+
|
|
162
|
+
Rules in HOSTS syntax: `/hosts.txt`
|
|
163
|
+
|
|
164
|
+
```txt
|
|
165
|
+
0.0.0.0 ads.example.com
|
|
166
|
+
0.0.0.0 tracking.example1.com
|
|
167
|
+
0.0.0.0 example.com
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Exclusion rules in adblock syntax: `/exclusions.txt`
|
|
171
|
+
|
|
172
|
+
```txt
|
|
173
|
+
||example.com^
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Configuration of the final list:
|
|
177
|
+
|
|
178
|
+
```json
|
|
179
|
+
{
|
|
180
|
+
"name": "List name",
|
|
181
|
+
"description": "List description",
|
|
182
|
+
"sources": [
|
|
183
|
+
{
|
|
184
|
+
"name": "HOSTS rules",
|
|
185
|
+
"source": "hosts.txt",
|
|
186
|
+
"type": "hosts",
|
|
187
|
+
"transformations": ["Compress"]
|
|
188
|
+
}
|
|
189
|
+
],
|
|
190
|
+
"transformations": ["Deduplicate", "Compress"],
|
|
191
|
+
"exclusions_sources": ["exclusions.txt"]
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Final filter output of `/hosts.txt` after applying the `Compress` transformation and exclusions:
|
|
196
|
+
|
|
197
|
+
```txt
|
|
198
|
+
||ads.example.com^
|
|
199
|
+
||tracking.example1.com^
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
The last rule now `||example.com^` will correctly match the rule from the exclusion list and will be excluded.
|
|
203
|
+
|
|
155
204
|
### <a name="command-line"></a> Command-line
|
|
156
205
|
|
|
157
206
|
Command-line arguments.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adguard/hostlist-compiler",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.37",
|
|
4
4
|
"description": "A simple tool that compiles hosts blocklists from multiple sources",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"types": "src/index.d.ts",
|
|
@@ -23,11 +23,12 @@
|
|
|
23
23
|
"eslint": "^8.34.0",
|
|
24
24
|
"eslint-config-airbnb-base": "^15.0.0",
|
|
25
25
|
"eslint-plugin-import": "^2.27.5",
|
|
26
|
-
"jest": "^
|
|
26
|
+
"jest": "^29.7.0",
|
|
27
27
|
"mock-fs": "^4.11.0",
|
|
28
28
|
"nock": "^12.0.2"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
+
"@adguard/filters-downloader": "^2.2.6",
|
|
31
32
|
"ajv": "^6.12.0",
|
|
32
33
|
"ajv-errors": "^1.0.1",
|
|
33
34
|
"axios": "^0.19.2",
|
package/src/compile-source.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
const consola = require('consola');
|
|
2
|
-
const
|
|
2
|
+
const { FiltersDownloader } = require('@adguard/filters-downloader');
|
|
3
3
|
const { transform } = require('./transformations/transform');
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -21,8 +21,7 @@ const { transform } = require('./transformations/transform');
|
|
|
21
21
|
*/
|
|
22
22
|
async function compileSource(source) {
|
|
23
23
|
consola.info(`Start compiling ${source.source}`);
|
|
24
|
-
|
|
25
|
-
let rules = str.split(/\r?\n/);
|
|
24
|
+
let rules = await FiltersDownloader.download(source.source);
|
|
26
25
|
consola.info(`Original length is ${rules.length}`);
|
|
27
26
|
|
|
28
27
|
rules = await transform(rules, source, source.transformations);
|
package/src/filter.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
const _ = require('lodash');
|
|
2
|
+
const { FiltersDownloader } = require('@adguard/filters-downloader');
|
|
2
3
|
const utils = require('./utils');
|
|
3
4
|
const ruleUtils = require('./rule');
|
|
4
5
|
|
|
@@ -16,9 +17,8 @@ async function downloadAll(sources) {
|
|
|
16
17
|
}
|
|
17
18
|
|
|
18
19
|
await Promise.all(sources.map(async (s) => {
|
|
19
|
-
const rulesStr = await
|
|
20
|
+
const rulesStr = await FiltersDownloader.download(s);
|
|
20
21
|
const rules = rulesStr
|
|
21
|
-
.split(/\r?\n/)
|
|
22
22
|
.filter((el) => el.trim().length > 0 && !ruleUtils.isComment(el));
|
|
23
23
|
list = list.concat(rules);
|
|
24
24
|
}));
|
package/src/utils.js
CHANGED
|
@@ -1,36 +1,4 @@
|
|
|
1
1
|
const _ = require('lodash');
|
|
2
|
-
const fs = require('fs').promises;
|
|
3
|
-
const axios = require('axios');
|
|
4
|
-
|
|
5
|
-
function isURL(str) {
|
|
6
|
-
try {
|
|
7
|
-
// eslint-disable-next-line no-unused-vars
|
|
8
|
-
const u = new URL(str);
|
|
9
|
-
return true;
|
|
10
|
-
} catch {
|
|
11
|
-
return false;
|
|
12
|
-
}
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Downloads (or reads from the disk) the specified source
|
|
17
|
-
*
|
|
18
|
-
* @param {*} urlOrPath url or path to a file
|
|
19
|
-
* @returns {Promise<String>} contents of the files
|
|
20
|
-
*/
|
|
21
|
-
async function download(urlOrPath) {
|
|
22
|
-
let str = '';
|
|
23
|
-
|
|
24
|
-
if (isURL(urlOrPath)) {
|
|
25
|
-
const url = new URL(urlOrPath);
|
|
26
|
-
const response = await axios.get(url.toString(), { responseType: 'text' });
|
|
27
|
-
str = response.data;
|
|
28
|
-
} else {
|
|
29
|
-
str = (await fs.readFile(urlOrPath)).toString();
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
return str;
|
|
33
|
-
}
|
|
34
2
|
|
|
35
3
|
/**
|
|
36
4
|
* Extracts a substring between two tags.
|
|
@@ -169,7 +137,6 @@ class Wildcard {
|
|
|
169
137
|
}
|
|
170
138
|
|
|
171
139
|
module.exports = {
|
|
172
|
-
download,
|
|
173
140
|
Wildcard,
|
|
174
141
|
splitByDelimiterWithEscapeCharacter,
|
|
175
142
|
substringBetween,
|
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
const nock = require('nock');
|
|
2
2
|
const mock = require('mock-fs');
|
|
3
|
+
const path = require('path');
|
|
3
4
|
const compileSource = require('../src/compile-source');
|
|
4
5
|
const { TRANSFORMATIONS } = require('../src/transformations/transform');
|
|
5
6
|
|
|
7
|
+
const testDirPath = path.resolve(__dirname, 'test/dir');
|
|
8
|
+
const rulesFilePath = path.resolve(testDirPath, 'rules.txt');
|
|
9
|
+
const exclusionsFilePath = path.resolve(testDirPath, 'exclusions.txt');
|
|
10
|
+
|
|
6
11
|
describe('Source compiler', () => {
|
|
7
12
|
afterEach(() => {
|
|
8
13
|
// make sure FS is restored after running tests
|
|
@@ -12,7 +17,9 @@ describe('Source compiler', () => {
|
|
|
12
17
|
it('compile a simple URL source', async () => {
|
|
13
18
|
const scope = nock('https://example.org')
|
|
14
19
|
.get('/filter.txt')
|
|
15
|
-
.reply(200, 'testrule'
|
|
20
|
+
.reply(200, 'testrule', {
|
|
21
|
+
'Content-Type': 'text/plain',
|
|
22
|
+
});
|
|
16
23
|
|
|
17
24
|
const source = {
|
|
18
25
|
name: 'test source',
|
|
@@ -29,13 +36,13 @@ describe('Source compiler', () => {
|
|
|
29
36
|
|
|
30
37
|
it('compile a simple file source', async () => {
|
|
31
38
|
mock({
|
|
32
|
-
|
|
39
|
+
[testDirPath]: {
|
|
33
40
|
'rules.txt': 'testrule',
|
|
34
41
|
},
|
|
35
42
|
});
|
|
36
43
|
const source = {
|
|
37
44
|
name: 'test source',
|
|
38
|
-
source:
|
|
45
|
+
source: rulesFilePath,
|
|
39
46
|
};
|
|
40
47
|
|
|
41
48
|
const rules = await compileSource(source);
|
|
@@ -53,13 +60,15 @@ describe('Source compiler', () => {
|
|
|
53
60
|
||rule4`;
|
|
54
61
|
const scope = nock('https://example.org')
|
|
55
62
|
.get('/filter.txt')
|
|
56
|
-
.reply(200, rules
|
|
63
|
+
.reply(200, rules, {
|
|
64
|
+
'Content-Type': 'text/plain',
|
|
65
|
+
});
|
|
57
66
|
|
|
58
67
|
// STEP 2: MOCK EXCLUSIONS
|
|
59
68
|
const exclusions = `||rule1
|
|
60
69
|
||rule3`;
|
|
61
70
|
mock({
|
|
62
|
-
|
|
71
|
+
[testDirPath]: {
|
|
63
72
|
'exclusions.txt': exclusions,
|
|
64
73
|
},
|
|
65
74
|
});
|
|
@@ -68,7 +77,7 @@ describe('Source compiler', () => {
|
|
|
68
77
|
name: 'test source',
|
|
69
78
|
source: 'https://example.org/filter.txt',
|
|
70
79
|
exclusions: ['rule4'],
|
|
71
|
-
exclusions_sources: [
|
|
80
|
+
exclusions_sources: [exclusionsFilePath],
|
|
72
81
|
transformations: [
|
|
73
82
|
TRANSFORMATIONS.Deduplicate,
|
|
74
83
|
TRANSFORMATIONS.Validate,
|
|
@@ -99,7 +108,9 @@ describe('Source compiler', () => {
|
|
|
99
108
|
test2.com`;
|
|
100
109
|
const scope = nock('https://example.org')
|
|
101
110
|
.get('/test-filter.txt')
|
|
102
|
-
.reply(200, testList
|
|
111
|
+
.reply(200, testList, {
|
|
112
|
+
'Content-Type': 'text/plain',
|
|
113
|
+
});
|
|
103
114
|
|
|
104
115
|
const source = {
|
|
105
116
|
name: 'test source',
|
|
@@ -134,7 +145,9 @@ describe('Source compiler', () => {
|
|
|
134
145
|
||*.հայ^`;
|
|
135
146
|
const scope = nock('https://example.org')
|
|
136
147
|
.get('/test-filter.txt')
|
|
137
|
-
.reply(200, testList
|
|
148
|
+
.reply(200, testList, {
|
|
149
|
+
'Content-Type': 'text/plain',
|
|
150
|
+
});
|
|
138
151
|
|
|
139
152
|
const source = {
|
|
140
153
|
name: 'test source',
|
package/test/index.test.js
CHANGED
|
@@ -7,9 +7,13 @@ describe('Hostlist compiler', () => {
|
|
|
7
7
|
// Prepare source 1
|
|
8
8
|
const scope = nock('https://example.org')
|
|
9
9
|
.get('/source1.txt')
|
|
10
|
-
.reply(200, '||example.org'
|
|
10
|
+
.reply(200, '||example.org', {
|
|
11
|
+
'Content-Type': 'text/plain',
|
|
12
|
+
})
|
|
11
13
|
.get('/source2.txt')
|
|
12
|
-
.reply(200, '||example.com'
|
|
14
|
+
.reply(200, '||example.com', {
|
|
15
|
+
'Content-Type': 'text/plain',
|
|
16
|
+
});
|
|
13
17
|
|
|
14
18
|
// compiler configuration
|
|
15
19
|
const configuration = {
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
const nock = require('nock');
|
|
2
|
+
const consola = require('consola');
|
|
3
|
+
const path = require('path');
|
|
4
|
+
const compile = require('../src/index');
|
|
5
|
+
|
|
6
|
+
const testDirPath = path.resolve(__dirname, 'resources');
|
|
7
|
+
const filterFilePath = path.resolve(testDirPath, 'rules.txt');
|
|
8
|
+
|
|
9
|
+
describe('Hostlist compiler', () => {
|
|
10
|
+
it('compile from one source with nested includes', async () => {
|
|
11
|
+
// Prepare filters content
|
|
12
|
+
const filterContent1 = `! this is a source
|
|
13
|
+
||example.org
|
|
14
|
+
||example.com
|
|
15
|
+
!#include https://example.org/source2.txt`;
|
|
16
|
+
|
|
17
|
+
const filterContent2 = `
|
|
18
|
+
||example.net
|
|
19
|
+
||example.io
|
|
20
|
+
!#include https://example.org/source3.txt`;
|
|
21
|
+
|
|
22
|
+
const filterContent3 = `
|
|
23
|
+
last.include.com
|
|
24
|
+
non/valid_rule`;
|
|
25
|
+
|
|
26
|
+
// Prepare source
|
|
27
|
+
const scope = nock('https://example.org')
|
|
28
|
+
.get('/source1.txt')
|
|
29
|
+
.reply(200, filterContent1, {
|
|
30
|
+
'Content-Type': 'text/plain',
|
|
31
|
+
})
|
|
32
|
+
.get('/source2.txt')
|
|
33
|
+
.reply(200, filterContent2, {
|
|
34
|
+
'Content-Type': 'text/plain',
|
|
35
|
+
})
|
|
36
|
+
.get('/source3.txt')
|
|
37
|
+
.reply(200, filterContent3, {
|
|
38
|
+
'Content-Type': 'text/plain',
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
// compiler configuration
|
|
42
|
+
const configuration = {
|
|
43
|
+
name: 'Test filter',
|
|
44
|
+
description: 'Our test filter',
|
|
45
|
+
version: '1.0.0.9',
|
|
46
|
+
sources: [
|
|
47
|
+
{
|
|
48
|
+
name: 'source 1',
|
|
49
|
+
source: 'https://example.org/source1.txt',
|
|
50
|
+
},
|
|
51
|
+
],
|
|
52
|
+
transformations: [
|
|
53
|
+
'RemoveComments',
|
|
54
|
+
'Compress',
|
|
55
|
+
'InsertFinalNewLine',
|
|
56
|
+
'Validate',
|
|
57
|
+
],
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
// compile the final list
|
|
61
|
+
const list = await compile(configuration);
|
|
62
|
+
|
|
63
|
+
// assert
|
|
64
|
+
const expectedRules = [
|
|
65
|
+
'||example.org',
|
|
66
|
+
'||example.com',
|
|
67
|
+
'||example.net',
|
|
68
|
+
'||example.io',
|
|
69
|
+
'||last.include.com^',
|
|
70
|
+
];
|
|
71
|
+
|
|
72
|
+
expectedRules.forEach((rule) => {
|
|
73
|
+
expect(list).toContain(rule);
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
expect(list).not.toContain('non/valid_rule');
|
|
77
|
+
|
|
78
|
+
expect(list).toContain('! Version: 1.0.0.9');
|
|
79
|
+
|
|
80
|
+
const str = list.join('\n');
|
|
81
|
+
consola.info(str);
|
|
82
|
+
|
|
83
|
+
scope.done();
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it('compile from one source with include and exclude file', async () => {
|
|
87
|
+
// Prepare filters content
|
|
88
|
+
const filterContent1 = `! this is a source
|
|
89
|
+
ads.example.com
|
|
90
|
+
trackers.exclude.com
|
|
91
|
+
exclude.com
|
|
92
|
+
!#include https://example.org/source2.txt`;
|
|
93
|
+
|
|
94
|
+
const filterContent2 = `
|
|
95
|
+
popups.com
|
|
96
|
+
event.com`;
|
|
97
|
+
|
|
98
|
+
const exclusionsContent = `
|
|
99
|
+
exclude.com
|
|
100
|
+
non/valid_rule`;
|
|
101
|
+
|
|
102
|
+
// Prepare source
|
|
103
|
+
const scope = nock('https://example.org')
|
|
104
|
+
.get('/source1.txt')
|
|
105
|
+
.reply(200, filterContent1, {
|
|
106
|
+
'Content-Type': 'text/plain',
|
|
107
|
+
})
|
|
108
|
+
.get('/source2.txt')
|
|
109
|
+
.reply(200, filterContent2, {
|
|
110
|
+
'Content-Type': 'text/plain',
|
|
111
|
+
})
|
|
112
|
+
.get('/exclusions.txt')
|
|
113
|
+
.reply(200, exclusionsContent, {
|
|
114
|
+
'Content-Type': 'text/plain',
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
// compiler configuration
|
|
118
|
+
const configuration = {
|
|
119
|
+
name: 'Test filter',
|
|
120
|
+
description: 'Our test filter',
|
|
121
|
+
version: '1.0.0.9',
|
|
122
|
+
sources: [
|
|
123
|
+
{
|
|
124
|
+
name: 'source 1',
|
|
125
|
+
source: 'https://example.org/source1.txt',
|
|
126
|
+
},
|
|
127
|
+
],
|
|
128
|
+
transformations: [
|
|
129
|
+
'RemoveComments',
|
|
130
|
+
'Compress',
|
|
131
|
+
'InsertFinalNewLine',
|
|
132
|
+
'Validate',
|
|
133
|
+
],
|
|
134
|
+
exclusions_sources: [
|
|
135
|
+
'https://example.org/exclusions.txt',
|
|
136
|
+
],
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
// compile the final list
|
|
140
|
+
const list = await compile(configuration);
|
|
141
|
+
|
|
142
|
+
// assert
|
|
143
|
+
const expectedRules = [
|
|
144
|
+
'||ads.example.com^',
|
|
145
|
+
'||popups.com^',
|
|
146
|
+
'||event.com^',
|
|
147
|
+
];
|
|
148
|
+
|
|
149
|
+
expectedRules.forEach((rule) => {
|
|
150
|
+
expect(list).toContain(rule);
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
expect(list).not.toContain('||exclude.com^', 'non/valid_rule');
|
|
154
|
+
|
|
155
|
+
expect(list).toContain('! Version: 1.0.0.9');
|
|
156
|
+
|
|
157
|
+
const str = list.join('\n');
|
|
158
|
+
consola.info(str);
|
|
159
|
+
|
|
160
|
+
scope.done();
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
it('compile from local source with local include', async () => {
|
|
164
|
+
// compiler configuration
|
|
165
|
+
const configuration = {
|
|
166
|
+
name: 'Test filter',
|
|
167
|
+
description: 'Our test filter',
|
|
168
|
+
version: '1.0.0.9',
|
|
169
|
+
sources: [
|
|
170
|
+
{
|
|
171
|
+
name: 'filter',
|
|
172
|
+
source: filterFilePath,
|
|
173
|
+
},
|
|
174
|
+
],
|
|
175
|
+
transformations: [
|
|
176
|
+
'RemoveComments',
|
|
177
|
+
'Compress',
|
|
178
|
+
'InsertFinalNewLine',
|
|
179
|
+
'Validate',
|
|
180
|
+
],
|
|
181
|
+
};
|
|
182
|
+
|
|
183
|
+
// compile the final list
|
|
184
|
+
const list = await compile(configuration);
|
|
185
|
+
|
|
186
|
+
const str = list.join('\n');
|
|
187
|
+
consola.info(str);
|
|
188
|
+
|
|
189
|
+
const expectedRules = [
|
|
190
|
+
'||sat.terithrow2.net^',
|
|
191
|
+
'||sat.fevilsor5.net^',
|
|
192
|
+
'||leegreemula.net^',
|
|
193
|
+
'||should.be.included.com^',
|
|
194
|
+
'||last.rule^',
|
|
195
|
+
];
|
|
196
|
+
|
|
197
|
+
expectedRules.forEach((rule) => {
|
|
198
|
+
expect(list).toContain(rule);
|
|
199
|
+
});
|
|
200
|
+
});
|
|
201
|
+
});
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
const nock = require('nock');
|
|
2
2
|
const mock = require('mock-fs');
|
|
3
|
+
const path = require('path');
|
|
3
4
|
const exclude = require('../../src/transformations/exclude');
|
|
4
5
|
|
|
6
|
+
const testDirPath = path.resolve(__dirname, 'test/dir');
|
|
7
|
+
const exclusionsFilePath = path.resolve(testDirPath, 'exclusions.txt');
|
|
8
|
+
|
|
5
9
|
describe('Exclusions', () => {
|
|
6
10
|
afterEach(() => {
|
|
7
11
|
// make sure FS is restored after running tests
|
|
@@ -20,11 +24,15 @@ describe('Exclusions', () => {
|
|
|
20
24
|
// Mock exclusions
|
|
21
25
|
const scope = nock('https://example.org')
|
|
22
26
|
.get('/exclusions.txt')
|
|
23
|
-
.reply(200, 'rule1'
|
|
27
|
+
.reply(200, 'rule1', {
|
|
28
|
+
'Content-Type': 'text/plain',
|
|
29
|
+
})
|
|
24
30
|
.get('/exclusions2.txt')
|
|
25
|
-
.reply(200, 'rule2'
|
|
31
|
+
.reply(200, 'rule2', {
|
|
32
|
+
'Content-Type': 'text/plain',
|
|
33
|
+
});
|
|
26
34
|
mock({
|
|
27
|
-
|
|
35
|
+
[testDirPath]: {
|
|
28
36
|
'exclusions.txt': 'rule3',
|
|
29
37
|
},
|
|
30
38
|
});
|
|
@@ -36,7 +44,7 @@ describe('Exclusions', () => {
|
|
|
36
44
|
const filtered = await exclude(
|
|
37
45
|
rules,
|
|
38
46
|
['rule4'],
|
|
39
|
-
['https://example.org/exclusions.txt', 'https://example.org/exclusions2.txt',
|
|
47
|
+
['https://example.org/exclusions.txt', 'https://example.org/exclusions2.txt', exclusionsFilePath],
|
|
40
48
|
);
|
|
41
49
|
|
|
42
50
|
// Assert
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
const nock = require('nock');
|
|
2
2
|
const mock = require('mock-fs');
|
|
3
|
+
const path = require('path');
|
|
3
4
|
const include = require('../../src/transformations/include');
|
|
4
5
|
|
|
6
|
+
const testDirPath = path.resolve(__dirname, 'test/dir');
|
|
7
|
+
const inclusionsFilePath = path.resolve(testDirPath, 'inclusions.txt');
|
|
8
|
+
|
|
5
9
|
describe('Exclusions', () => {
|
|
6
10
|
afterEach(() => {
|
|
7
11
|
// make sure FS is restored after running tests
|
|
@@ -39,11 +43,15 @@ describe('Exclusions', () => {
|
|
|
39
43
|
// Mock inclusions sources
|
|
40
44
|
const scope = nock('https://example.org')
|
|
41
45
|
.get('/inclusions.txt')
|
|
42
|
-
.reply(200, 'rule1'
|
|
46
|
+
.reply(200, 'rule1', {
|
|
47
|
+
'Content-Type': 'text/plain',
|
|
48
|
+
})
|
|
43
49
|
.get('/inclusions2.txt')
|
|
44
|
-
.reply(200, 'rule2'
|
|
50
|
+
.reply(200, 'rule2', {
|
|
51
|
+
'Content-Type': 'text/plain',
|
|
52
|
+
});
|
|
45
53
|
mock({
|
|
46
|
-
|
|
54
|
+
[testDirPath]: {
|
|
47
55
|
'inclusions.txt': 'rule3',
|
|
48
56
|
},
|
|
49
57
|
});
|
|
@@ -56,7 +64,7 @@ describe('Exclusions', () => {
|
|
|
56
64
|
const inclusionsSources = [
|
|
57
65
|
'https://example.org/inclusions.txt',
|
|
58
66
|
'https://example.org/inclusions2.txt',
|
|
59
|
-
|
|
67
|
+
inclusionsFilePath,
|
|
60
68
|
];
|
|
61
69
|
|
|
62
70
|
// Include!
|