class GhostPlugin(Plugin):
name = 'ghost'
homepage = 'https://www.ghost.org/'
tags = ['blog', 'node.js']
matchers = [
{'xpath': (meta_generator('Ghost'), r'(?P<version>[0-9\.]+)')},
]
class GhostPlugin(Plugin):
name = 'ghost'
homepage = 'https://www.ghost.org/'
matchers = [
{
'xpath': (meta_generator('Ghost'), '(?P<version>[0-9\.]+)')
},
]
class TestDetector:
HAR_ENTRY_1 = {
"request": {
"url": "http://domain.tld/libA-1.4.2.js"
},
"response": {
"url": "http://domain.tld/libA-1.4.2.js"
},
}
HAR_NO_URL_REDIRECT = [
{
"request": {
"url": "http://domain.tld/"
},
"response": {}
},
{
"request": {
"url": "http://domain.tld/js/script.js"
},
"response": {}
},
]
HAR_URL_REDIRECT_PATH = [
{
"request": {
"url": "http://domain.tld/"
},
"response": {
"headers": [{
"name": "Location",
"value": "/new/default.html"
}]
},
},
{
"request": {
"url": "http://domain.tld/new/default.html"
},
"response": {}
},
]
HAR_URL_REDIRECT_ABS = [
{
"request": {
"url": "http://domain.tld/"
},
"response": {
"headers": [{
"name": "Location",
"value": "http://other-domain.tld/"
}]
},
},
{
"request": {
"url": "http://other-domain.tld/"
},
"response": {}
},
]
URL = "http://domain.tld/"
FOO_PLUGIN = {
"name": "foo",
"homepage": "foo",
"version_matchers": {
"url": r"foo.*-(?P<version>[0-9\.]+)\.js",
"header": ("FooHeader", r"Foo.* v(?P<version>[0-9\.]+)"),
"body": r"Foo.* v(?P<version>[0-9\.]+)",
"xpath": (meta_generator("foo-min"), r"(?P<version>[0-9\.]+)"),
},
"presence_matchers": {
"url": r"foo.*\.js",
"header": ("FooHeader", "Foo"),
"body": "Foo",
"xpath": "//meta[@name='generator']",
},
"name_matchers": {
"url": r"foo-(?P<name>\w+)-.*\.js",
"header": ("FooHeader", r"Foo-(?P<name>\w+)"),
"body": r"Foo-(?P<name>\w+)",
"xpath": (meta_generator("foo-min"), r"foo-(?P<name>\w+)"),
},
}
FOO_RESULTS = [
[{
"name": "foo",
"version": "1.1"
}],
[{
"name": "foo"
}],
[{
"name": "foo-min",
"version": "1.1"
}],
]
MATCHER_SOURCES = [
"version_matchers", "presence_matchers", "name_matchers"
]
def test_convert_inline_script_to_har_entry(self):
script = "Inline script"
d = Detector({
"har": [],
"softwares": [],
"scripts": [script]
}, None, self.URL)
e = d.har[0]
assert e["request"]["url"] == self.URL
assert e["response"]["content"]["text"] == script
@pytest.mark.parametrize("scripts,n_entries",
[([], 0), (["script1", "script2"], 2)])
def test_add_inline_scripts_to_har(self, scripts, n_entries):
d = Detector({
"har": [],
"softwares": [],
"scripts": scripts
}, None, self.URL)
assert len(d.har) == n_entries
def _create_plugin(self, template, source, matchers):
class TestPlugin(Plugin):
name = template["name"]
homepage = template["homepage"]
p = TestPlugin()
g = [{m: template[source][m]} for m in matchers]
p.matchers = g
return p
def _create_detector(self, har, plugins):
pc = PluginCollection()
for p in plugins:
pc.add(p)
return Detector({"har": har, "softwares": []}, pc, self.URL)
@pytest.mark.parametrize("sources,result", zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_headers(self, sources, result):
har = [{
"request": {
"url": self.URL
},
"response": {
"url": self.URL,
"headers": [{
"name": "FooHeader",
"value": "Foo-min v1.1"
}],
},
}]
p = self._create_plugin(self.FOO_PLUGIN, sources, ["header"])
d = self._create_detector(har, [p])
assert d.get_results() == result
@pytest.mark.parametrize("sources", MATCHER_SOURCES)
def test_match_from_headers_ignores_resource_entries(self, sources):
har = [
{
"request": {
"url": self.URL
},
"response": {
"url": self.URL,
"headers": []
},
},
{
"request": {
"url": "http://foo.org/lib/foo.js"
},
"response": {
"url": "http://foo.org/lib/foo.js",
"headers": [{
"name": "FooHeader",
"value": "Foo-min v1.1"
}],
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ["header"])
d = self._create_detector(har, [p])
assert not d.get_results()
@pytest.mark.parametrize("sources,result", zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_body(self, sources, result):
har = [
{
"request": {
"url": self.URL
},
"response": {
"url": self.URL,
"content": {
"text": "Main content"
}
},
},
{
"request": {
"url": "http://foo.org/lib/foo.js"
},
"response": {
"url": "http://foo.org/lib/foo.js",
"content": {
"text": "Plugin Foo-min v1.1"
},
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ["body"])
d = self._create_detector(har, [p])
assert d.get_results() == result
@pytest.mark.parametrize("sources", MATCHER_SOURCES)
def test_match_from_body_excludes_main_entry(self, sources):
har = [{
"request": {
"url": self.URL
},
"response": {
"url": self.URL,
"content": {
"text": "About Foo-min v1.1"
},
},
}]
p = self._create_plugin(self.FOO_PLUGIN, sources, ["body"])
d = self._create_detector(har, [p])
assert not d.get_results()
@pytest.mark.parametrize("sources,result", zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_url(self, sources, result):
har = [
{
"request": {
"url": self.URL
},
"response": {
"url": self.URL
}
},
{
"request": {
"url": "http://foo.org/lib/foo-min-1.1.js"
},
"response": {
"url": "http://foo.org/lib/foo-min-1.1.js"
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ["url"])
d = self._create_detector(har, [p])
assert d.get_results() == result
@pytest.mark.parametrize("sources,result", zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_xpath(self, sources, result):
har = [{
"request": {
"url": self.URL
},
"response": {
"url": self.URL,
"content": {
"text": '<meta name="generator" content="foo-min 1.1">'
},
},
}]
p = self._create_plugin(self.FOO_PLUGIN, sources, ["xpath"])
d = self._create_detector(har, [p])
assert d.get_results() == result
def test_get_hints_with_valid_hint(self):
class TestPlugin(Plugin):
name = "test"
homepage = "test"
class BlaPlugin(Plugin):
name = "bla"
hints = ["test"]
detector = self._create_detector(None, [TestPlugin()])
hints = detector.get_hints(BlaPlugin())
assert hints
def test_get_hints_with_invalid_hint(self):
class BlaPlugin(Plugin):
name = "bla"
hints = ["test"]
detector = self._create_detector(None, [])
hints = detector.get_hints(BlaPlugin())
assert not hints
class GhostPlugin(Plugin):
name = "ghost"
homepage = "https://www.ghost.org/"
tags = ["blog", "node.js"]
matchers = [{"xpath": (meta_generator("Ghost"), r"(?P<version>[0-9\.]+)")}]
class TestDetector():
HAR_ENTRY_1 = {
'request': {
'url': 'http://domain.tld/libA-1.4.2.js'
},
'response': {
'url': 'http://domain.tld/libA-1.4.2.js'
},
}
HAR_NO_URL_REDIRECT = [{
'request': {
'url': 'http://domain.tld/'
},
'response': {},
}, {
'request': {
'url': 'http://domain.tld/js/script.js'
},
'response': {},
}]
HAR_URL_REDIRECT_PATH = [{
'request': {
'url': 'http://domain.tld/'
},
'response': {
'headers': [{
'name': 'Location',
'value': '/new/default.html'
}]
},
}, {
'request': {
'url': 'http://domain.tld/new/default.html'
},
'response': {},
}]
HAR_URL_REDIRECT_ABS = [{
'request': {
'url': 'http://domain.tld/'
},
'response': {
'headers': [{
'name': 'Location',
'value': 'http://other-domain.tld/'
}]
},
}, {
'request': {
'url': 'http://other-domain.tld/'
},
'response': {},
}]
URL = 'http://domain.tld/'
FOO_PLUGIN = {
'name': 'foo',
'homepage': 'foo',
'version_matchers': {
'url': r'foo.*-(?P<version>[0-9\.]+)\.js',
'header': ('FooHeader', r'Foo.* v(?P<version>[0-9\.]+)'),
'body': r'Foo.* v(?P<version>[0-9\.]+)',
'xpath': (meta_generator('foo-min'), r'(?P<version>[0-9\.]+)'),
},
'presence_matchers': {
'url': r'foo.*\.js',
'header': ('FooHeader', 'Foo'),
'body': 'Foo',
'xpath': "//meta[@name='generator']",
},
'name_matchers': {
'url': r'foo-(?P<name>\w+)-.*\.js',
'header': ('FooHeader', r'Foo-(?P<name>\w+)'),
'body': r'Foo-(?P<name>\w+)',
'xpath': (meta_generator('foo-min'), r'foo-(?P<name>\w+)'),
},
}
FOO_RESULTS = [
[{
'name': 'foo',
'version': '1.1'
}],
[{
'name': 'foo'
}],
[{
'name': 'foo-min',
'version': '1.1'
}],
]
MATCHER_SOURCES = [
'version_matchers',
'presence_matchers',
'name_matchers',
]
def test_convert_inline_script_to_har_entry(self):
script = 'Inline script'
d = Detector({
'har': [],
'softwares': [],
'scripts': [script]
}, None, self.URL)
e = d.har[0]
assert e['request']['url'] == self.URL
assert e['response']['content']['text'] == script
@pytest.mark.parametrize("scripts,n_entries", [
([], 0),
(['script1', 'script2'], 2),
])
def test_add_inline_scripts_to_har(self, scripts, n_entries):
d = Detector({
'har': [],
'softwares': [],
'scripts': scripts
}, None, self.URL)
assert len(d.har) == n_entries
def _create_plugin(self, template, source, matchers):
class TestPlugin(Plugin):
name = template['name']
homepage = template['homepage']
p = TestPlugin()
g = [{m: template[source][m]} for m in matchers]
p.matchers = g
return p
def _create_detector(self, har, plugins):
pc = PluginCollection()
for p in plugins:
pc.add(p)
return Detector({'har': har, 'softwares': []}, pc, self.URL)
@pytest.mark.parametrize('sources,result', zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_headers(self, sources, result):
har = [
{
'request': {
'url': self.URL
},
'response': {
'url': self.URL,
'headers': [{
'name': 'FooHeader',
'value': 'Foo-min v1.1'
}]
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ['header'])
d = self._create_detector(har, [p])
assert d.get_results() == result
@pytest.mark.parametrize('sources', MATCHER_SOURCES)
def test_match_from_headers_ignores_resource_entries(self, sources):
har = [
{
'request': {
'url': self.URL
},
'response': {
'url': self.URL,
'headers': [],
},
},
{
'request': {
'url': 'http://foo.org/lib/foo.js'
},
'response': {
'url': 'http://foo.org/lib/foo.js',
'headers': [{
'name': 'FooHeader',
'value': 'Foo-min v1.1'
}]
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ['header'])
d = self._create_detector(har, [p])
assert not d.get_results()
@pytest.mark.parametrize('sources,result', zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_body(self, sources, result):
har = [
{
'request': {
'url': self.URL
},
'response': {
'url': self.URL,
'content': {
'text': 'Main content'
},
},
},
{
'request': {
'url': 'http://foo.org/lib/foo.js'
},
'response': {
'url': 'http://foo.org/lib/foo.js',
'content': {
'text': 'Plugin Foo-min v1.1'
},
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ['body'])
d = self._create_detector(har, [p])
assert d.get_results() == result
@pytest.mark.parametrize('sources', MATCHER_SOURCES)
def test_match_from_body_excludes_main_entry(self, sources):
har = [
{
'request': {
'url': self.URL
},
'response': {
'url': self.URL,
'content': {
'text': 'About Foo-min v1.1'
},
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ['body'])
d = self._create_detector(har, [p])
assert not d.get_results()
@pytest.mark.parametrize('sources,result', zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_url(self, sources, result):
har = [
{
'request': {
'url': self.URL
},
'response': {
'url': self.URL
},
},
{
'request': {
'url': 'http://foo.org/lib/foo-min-1.1.js'
},
'response': {
'url': 'http://foo.org/lib/foo-min-1.1.js',
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ['url'])
d = self._create_detector(har, [p])
assert d.get_results() == result
@pytest.mark.parametrize('sources,result', zip(MATCHER_SOURCES,
FOO_RESULTS))
def test_match_from_xpath(self, sources, result):
har = [
{
'request': {
'url': self.URL
},
'response': {
'url': self.URL,
'content': {
'text': '<meta name="generator" content="foo-min 1.1">'
},
},
},
]
p = self._create_plugin(self.FOO_PLUGIN, sources, ['xpath'])
d = self._create_detector(har, [p])
assert d.get_results() == result
def test_get_hints_with_valid_hint(self):
class TestPlugin(Plugin):
name = 'test'
homepage = 'test'
class BlaPlugin(Plugin):
name = 'bla'
hints = ['test']
detector = self._create_detector(None, [TestPlugin()])
hints = detector.get_hints(BlaPlugin())
assert hints
def test_get_hints_with_invalid_hint(self):
class BlaPlugin(Plugin):
name = 'bla'
hints = ['test']
detector = self._create_detector(None, [])
hints = detector.get_hints(BlaPlugin())
assert not hints