2015-10-02 14:00:38 +02:00
|
|
|
"""
|
2017-10-28 19:25:20 +02:00
|
|
|
Fimfiction fetcher tests.
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Fimfarchive, preserves stories from Fimfiction.
|
2018-09-08 16:55:11 +02:00
|
|
|
# Copyright (C) 2018 Joakim Soderlund
|
2015-10-02 14:00:38 +02:00
|
|
|
#
|
|
|
|
|
# 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
|
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
# (at your option) any later version.
|
|
|
|
|
#
|
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
# 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/>.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
import pytest
|
|
|
|
|
|
|
|
|
|
from fimfarchive.exceptions import InvalidStoryError, StorySourceError
|
2017-10-28 19:25:20 +02:00
|
|
|
from fimfarchive.fetchers import FimfictionFetcher
|
2018-09-08 16:55:11 +02:00
|
|
|
from fimfarchive.utils import JayWalker
|
|
|
|
|
|
|
|
|
|
from tests.fixtures.responses import Recorder
|
2015-10-02 14:00:38 +02:00
|
|
|
|
|
|
|
|
|
2016-12-17 22:23:45 +01:00
|
|
|
VALID_STORY_KEY = 9
|
|
|
|
|
INVALID_STORY_KEY = 7
|
|
|
|
|
EMPTY_STORY_KEY = 8
|
|
|
|
|
PROTECTED_STORY_KEY = 208799
|
2015-10-02 14:00:38 +02:00
|
|
|
|
2016-12-18 19:46:46 +01:00
|
|
|
|
2018-09-08 16:55:11 +02:00
|
|
|
class Redactor(JayWalker):
|
|
|
|
|
"""
|
|
|
|
|
Redacts recorded responses.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def wrap(self, text: str) -> str:
|
|
|
|
|
"""
|
|
|
|
|
Wraps text in a valid HTML body.
|
|
|
|
|
"""
|
|
|
|
|
return f"<html><body>{text}</body></html>"
|
|
|
|
|
|
|
|
|
|
def handle(self, data, key, value) -> None:
|
|
|
|
|
if key in ('description', 'short_description'):
|
|
|
|
|
data[key] = "REDACTED"
|
|
|
|
|
elif key == 'text' and "<h1><a name='1'></a>" in value:
|
|
|
|
|
data[key] = self.wrap("<h1><a name='1'></a>REDACTED</h1>")
|
|
|
|
|
elif key == 'text':
|
|
|
|
|
data[key] = self.wrap("REDACTED")
|
|
|
|
|
else:
|
|
|
|
|
self.walk(value)
|
|
|
|
|
|
|
|
|
|
|
2015-10-02 14:00:38 +02:00
|
|
|
class TestFimfictionFetcher:
|
|
|
|
|
"""
|
|
|
|
|
FimfictionFetcher tests.
|
|
|
|
|
"""
|
|
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
@pytest.fixture
|
2018-09-08 16:55:11 +02:00
|
|
|
def fetcher(self, responses):
|
2016-12-18 03:13:25 +01:00
|
|
|
"""
|
|
|
|
|
Returns the fetcher instance to test.
|
|
|
|
|
"""
|
2018-09-08 16:55:11 +02:00
|
|
|
if isinstance(responses, Recorder):
|
|
|
|
|
responses.walker = Redactor()
|
|
|
|
|
|
|
|
|
|
yield FimfictionFetcher()
|
2015-10-02 14:00:38 +02:00
|
|
|
|
|
|
|
|
def test_with_statment(self):
|
|
|
|
|
"""
|
|
|
|
|
Tests fetcher can be used in with statements.
|
|
|
|
|
"""
|
|
|
|
|
with FimfictionFetcher() as fetcher:
|
|
|
|
|
fetcher.get('http://example.com/')
|
|
|
|
|
|
2018-09-08 16:55:11 +02:00
|
|
|
@pytest.mark.xfail(reason="Recorder issue")
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_get_for_invalid_host(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests `StorySourceError` is raised if server is unreachable.
|
|
|
|
|
"""
|
|
|
|
|
with pytest.raises(StorySourceError):
|
2016-12-18 03:13:25 +01:00
|
|
|
fetcher.get('http://-')
|
2015-10-02 14:00:38 +02:00
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_get_for_invalid_page(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests `StorySourceError` is raised if page does not exist.
|
|
|
|
|
|
|
|
|
|
Since Fimfiction always returns HTTP 200 OK, even for invalid stories,
|
|
|
|
|
other HTTP status codes indicate that something else has gone wrong.
|
|
|
|
|
"""
|
|
|
|
|
with pytest.raises(StorySourceError):
|
2016-12-18 03:13:25 +01:00
|
|
|
fetcher.get('http://example.com/-')
|
2015-10-02 14:00:38 +02:00
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_meta_for_valid_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests meta is returned if story is valid
|
|
|
|
|
"""
|
2016-12-18 03:13:25 +01:00
|
|
|
meta = fetcher.fetch_meta(VALID_STORY_KEY)
|
2016-12-17 22:23:45 +01:00
|
|
|
assert meta['id'] == VALID_STORY_KEY
|
2015-10-02 14:00:38 +02:00
|
|
|
assert meta['words'] != 0
|
|
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_meta_for_invalid_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests `InvalidStoryError` is raised if story is invalid.
|
|
|
|
|
"""
|
|
|
|
|
with pytest.raises(InvalidStoryError):
|
2016-12-18 03:13:25 +01:00
|
|
|
fetcher.fetch_meta(INVALID_STORY_KEY)
|
2015-10-02 14:00:38 +02:00
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_meta_for_empty_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests meta is returned if story is empty.
|
|
|
|
|
|
|
|
|
|
It would be feasible for the fetcher to raise `InvalidStoryError` here
|
|
|
|
|
since the story data is useless. But because the meta of such stories
|
|
|
|
|
may still be of interest, it was decided that meta should be returned.
|
|
|
|
|
"""
|
2016-12-18 03:13:25 +01:00
|
|
|
meta = fetcher.fetch_meta(EMPTY_STORY_KEY)
|
2016-12-17 22:23:45 +01:00
|
|
|
assert meta['id'] == EMPTY_STORY_KEY
|
2015-10-02 14:00:38 +02:00
|
|
|
assert meta['words'] == 0
|
|
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_meta_for_protected_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests meta is returned if story is protected.
|
|
|
|
|
|
|
|
|
|
It would be feasible for the fetcher to raise `InvalidStoryError` here
|
|
|
|
|
since the story data is inaccessible. However, there is no way to
|
|
|
|
|
determine that a story is password-protected from its meta data.
|
|
|
|
|
"""
|
2016-12-18 03:13:25 +01:00
|
|
|
meta = fetcher.fetch_meta(PROTECTED_STORY_KEY)
|
2016-12-17 22:23:45 +01:00
|
|
|
assert meta['id'] == PROTECTED_STORY_KEY
|
2015-10-02 14:00:38 +02:00
|
|
|
assert meta['words'] != 0
|
|
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_data_for_valid_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests data is returned if story is valid.
|
|
|
|
|
"""
|
2016-12-18 03:13:25 +01:00
|
|
|
data = fetcher.fetch_data(VALID_STORY_KEY)
|
2015-10-02 14:00:38 +02:00
|
|
|
assert len(data) != 0
|
|
|
|
|
|
2017-06-24 19:41:26 +02:00
|
|
|
@pytest.mark.xfail(reason='knighty/fimfiction-issues#139')
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_data_for_invalid_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests `InvalidStoryError` is raised if story is invalid.
|
|
|
|
|
"""
|
|
|
|
|
with pytest.raises(InvalidStoryError):
|
2016-12-18 03:13:25 +01:00
|
|
|
fetcher.fetch_data(INVALID_STORY_KEY)
|
2015-10-02 14:00:38 +02:00
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_data_for_empty_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests `InvalidStoryError` is raised if story is empty.
|
|
|
|
|
"""
|
|
|
|
|
with pytest.raises(InvalidStoryError):
|
2016-12-18 03:13:25 +01:00
|
|
|
fetcher.fetch_data(EMPTY_STORY_KEY)
|
2015-10-02 14:00:38 +02:00
|
|
|
|
2016-12-18 03:13:25 +01:00
|
|
|
def test_fetch_data_for_protected_story(self, fetcher):
|
2015-10-02 14:00:38 +02:00
|
|
|
"""
|
|
|
|
|
Tests `InvalidStoryError` is raised if story is protected.
|
|
|
|
|
"""
|
|
|
|
|
with pytest.raises(InvalidStoryError):
|
2016-12-18 03:13:25 +01:00
|
|
|
fetcher.fetch_data(PROTECTED_STORY_KEY)
|
