Feature: add backup command to make it easier of making a copy

Closes #29

Author: NyanKiyoshi

README.md

@@ -148,8 +148,9 @@ It will generate something [like this](https://pytest-django-queries.readthedocs
 
 ## Comparing Results
 
-When running pytest, pass the `--django-backup-queries` (can take a path, optionally)
-then you can run `django-queries diff` to generate results looking like this:
+You can run `django-queries backup` (can take a path, optionally) after
+running your tests then rerun them. After that, you can run `django-queries diff`
+to generate results looking like this:
 
 <a href='./docs/_static/diff_results.png'>
  <img src='./docs/_static/diff_results.png' alt='screenshot' width='500px' />

docs/diff.rst

@@ -3,10 +3,10 @@
 The Diff Command
 ----------------
 
-The plugin can backup the test results for you if you pass the ``--django-backup-queries [BACKUP_PATH]`` parameter to it. It will create a backup to ``.pytest-query.old`` by default if previous results were found.
+The plugin can backup the test results for you if you run the ``django-queries backup [BACKUP_PATH]`` command. It will create a backup to ``.pytest-query.old`` by default if previous results were found.
 
 .. warning::
 
  Bear in mind that it will override any existing backup file in the provided or default path.
 
-After running ``pytest --django-backup-queries``, you can run ``django-queries diff`` to show the changes. Make sure you actually had previous results, otherwise it will have nothing to compare.
+After running ``pytest`` again, you can run ``django-queries diff`` to show the changes. Make sure you actually had previous results, otherwise it will have nothing to compare.

docs/usage.rst

@@ -15,7 +15,9 @@ Customizing the Save Path
 Backing Up Results
 ++++++++++++++++++
 
-You can pass the ``--django-backup-queries`` parameter to backup previous results to `.pytest-django.old``.
+The easiest way is to run the ``django-queries backup`` command which will create a copy of the current results.
+
+Another way is by passing the ``--django-backup-queries`` parameter to backup previous results to `.pytest-django.old``.
 
 Or pass a custom path.
 

pytest_django_queries/cli.py

@@ -13,6 +13,7 @@
  DEFAULT_RESULT_FILENAME,
 )
 from pytest_django_queries.tables import entries_to_html, print_entries
+from pytest_django_queries.utils import create_backup
 
 HERE = dirname(__file__)
 DEFAULT_TEMPLATE_PATH = abspath(pathjoin(HERE, "templates", "default_bootstrap.jinja2"))
@@ -124,5 +125,13 @@ def diff(left_file, right_file):
  click.secho(line, fg=fg_color)
 
 
+@main.command()
+@click.argument("target_path", type=str, default=DEFAULT_OLD_RESULT_FILENAME)
+def backup(target_path):
+ source_path = DEFAULT_RESULT_FILENAME
+ click.echo("{0} -> {1}".format(source_path, target_path))
+ create_backup(source_path, target_path)
+
+
 if __name__ == "__main__":
  main()

pytest_django_queries/plugin.py

@@ -1,11 +1,12 @@
 import json
-import shutil
 from os.path import isfile
 
 import pytest
 from django.test.utils import CaptureQueriesContext
 
 # Defines the plugin marker name
+from pytest_django_queries.utils import create_backup
+
 PYTEST_QUERY_COUNT_MARKER = "count_queries"
 PYTEST_QUERY_COUNT_FIXTURE_NAME = "count_queries"
 DEFAULT_RESULT_FILENAME = ".pytest-queries"
@@ -20,10 +21,6 @@ def _get_session(request):
  return request.config.pytest_django_queries_session
 
 
-def _create_backup(save_path, backup_path):
- shutil.copy(save_path, backup_path)
-
-
 class _Session(object):
  def __init__(self, save_path, backup_path):
  """
@@ -43,7 +40,7 @@ def add_entry(self, module_name, test_name, query_count):
 
  def save_json(self):
  if self.backup_path and isfile(self.save_path):
- _create_backup(self.save_path, self.backup_path)
+ create_backup(self.save_path, self.backup_path)
 
  with open(self.save_path, "w") as fp:
  json.dump(self._data, fp, indent=2)

pytest_django_queries/utils.py

@@ -1,3 +1,4 @@
+import shutil
 import sys
 
 import click
@@ -14,3 +15,7 @@ def assert_type(value, expected_type):
  "Expected a %s, got %s instead"
  % (expected_type.__name__, type(value).__name__)
  )
+
+
+def create_backup(save_path, backup_path):
+ shutil.copy(save_path, backup_path)

tests/test_cli.py

@@ -219,3 +219,21 @@ def test_export_to_html_using_invalid_custom_template_should_fail(testdir):
  'Error: Invalid value for "--template": '
  "The file is not a valid jinja2 template: tag name expected" in result.stdout
  )
+
+
+def test_backup_command_is_making_a_backup(testdir):
+ results_file = str(testdir.tmpdir.join(".pytest-queries"))
+
+ with open(results_file, "w") as fp:
+ fp.write("hello!")
+
+ backup_file = testdir.tmpdir.join("backup.json")
+
+ runner = CliRunner()
+ result = runner.invoke(cli.main, ["backup", "backup.json"])
+ assert result.exit_code == 0, result.stdout
+ assert result.stdout == ".pytest-queries -> backup.json\n"
+
+ assert backup_file.check()
+ with open(str(backup_file), "r") as fp:
+ assert fp.read() == "hello!"

tests/test_plugin.py

@@ -210,7 +210,7 @@ def test_fixture_is_not_backing_up_if_not_asked_to(testdir):
  # and triggers a counting of the query number
  testdir.makepyfile(test_file=DUMMY_TEST_QUERY)
 
- with mock.patch("pytest_django_queries.plugin._create_backup") as mocked_backup:
+ with mock.patch("pytest_django_queries.plugin.create_backup") as mocked_backup:
  results = testdir.runpytest("--django-db-bench", results_path)
  assert mocked_backup.call_count == 0
 
@@ -228,7 +228,7 @@ def test_fixture_is_backing_up_old_results_to_default_path_if_no_path_provided(t
  # and triggers a counting of the query number
  testdir.makepyfile(test_file=DUMMY_TEST_QUERY)
 
- with mock.patch("pytest_django_queries.plugin._create_backup") as mocked_backup:
+ with mock.patch("pytest_django_queries.plugin.create_backup") as mocked_backup:
  from pytest_django_queries.plugin import DEFAULT_OLD_RESULT_FILENAME
 
  results = testdir.runpytest(