Merge pull request #170 from pythonpune/testcases

Added test cases

Author: ganeshhubale

readit/cli.py

@@ -29,7 +29,7 @@
 @click.option("--add", "-a", help="Add urls --> readit -a <url1> <url2>")
 @click.option("--tag", "-t", help="Use to tag url --> readit -a <url1> -t <tag1>")
 @click.option("--delete", "-d", help="Remove a URL of particular ID --> readit -d <url_id>")
-@click.option("--clear", "-c", help="Clear bookmarks --> readit -c")
+@click.option("--clear", "-c", nargs=0, help="Clear bookmarks --> readit -c")
 @click.option("--update", "-u", help="Update a URL for specific ID --> readit -u <existing_id> <new_url>")
 @click.option("--search", "-s", help="Search for bookmarks using either a tag or a substring of the URL --> readit -s <tag> or <substring>")
 @click.option("--view", "-v", multiple=True, nargs=0, help="Show bookmarks --> readit -v")

readit/database.py

@@ -310,7 +310,7 @@ def show_urls(self):
 
     def search_url(self, search_value):
         """
-        Displays a group of URLs associated with the provided search_value (tag).
+        Displays a group of URLs associated with the provided search_value (tag or url substring).
         """
         try:
             self.search = search_value.lower()
@@ -325,6 +325,7 @@ def search_url(self, search_value):
                 WHERE t.tag_name = ?
             """, (self.search,))  # Use a tuple with a trailing comma
             all_bookmarks = self.cursor.fetchall()
+
             if not all_bookmarks:
                 # If no bookmarks found with the tag, search in all URLs by given value as substring
                 bookmarks = self.show_urls() # Fetch all URls

setup.cfg

@@ -44,6 +44,7 @@ dev =
     readme_renderer
 test =
     pytest
+    pytest-mock
 
 [flake8]
 max_line_length = 100

tests/test_db.py

@@ -0,0 +1,129 @@
+import pytest
+import os
+from readit.database import DatabaseConnection
+
+@pytest.fixture
+def db_connection():
+    # Setup: Create a temporary database file for testing
+    db = DatabaseConnection()
+    yield db
+    # Teardown: Close the database and remove the temporary database file
+    db.db.close()
+    if os.path.exists(db.databasefile):
+        os.remove(db.databasefile)
+
+def test_init_db_creates_tables(db_connection):
+    # Test if the tables are created during initialization
+    cursor = db_connection.cursor
+    cursor.execute("SELECT name FROM sqlite_master WHERE type='table'")
+    tables = cursor.fetchall()
+    assert len(tables) == 4  # bookmarks, tags, url_tags and considering sqlite_sequence table too
+    assert ('bookmarks',) in tables
+    assert ('tags',) in tables
+    assert ('url_tags',) in tables
+
+def test_add_url_success(db_connection):
+    # Test successful addition of a URL
+    url = "http://example.com"
+    result = db_connection.add_url(url)
+    assert result == True
+
+    # Verify the URL was added to the database
+    cursor = db_connection.cursor
+    cursor.execute("SELECT url FROM bookmarks WHERE url=?", (url,))
+    assert cursor.fetchone()[0] == url
+
+def test_add_url_duplicate(db_connection):
+    # Test adding a duplicate URL
+    url = "http://example.com"
+    db_connection.add_url(url)  # First time
+    result = db_connection.add_url(url)  # Second time (should fail)
+    assert result == False
+
+def test_tag_url_success(db_connection):
+    # Test tagging a URL with a new tag
+    url = "http://example.com"
+    tag = "test"
+    result = db_connection.tag_url(url, tag)
+    assert result == True
+
+    # Verify the tag was added to the database
+    cursor = db_connection.cursor
+    cursor.execute("""
+        SELECT b.url, t.tag_name 
+        FROM bookmarks b 
+        JOIN url_tags ut ON b.id = ut.url_id 
+        JOIN tags t ON ut.tag_id = t.id
+        WHERE b.url=? AND t.tag_name=?
+    """, (url, tag))
+    assert cursor.fetchone() == (url, tag)
+
+def test_list_all_tags(db_connection):
+    # Test listing all tags
+    db_connection.tag_url("http://example.com", "test")
+    db_connection.tag_url("http://example.org", "example")
+
+    tags = db_connection.list_all_tags()
+    assert len(tags) == 2
+    assert "test" in tags
+    assert "example" in tags
+
+def test_delete_url(db_connection):
+    # Test deleting a URL and associated tags
+    url = "http://example.com"
+    db_connection.add_url(url)
+    db_connection.tag_url(url, "test")
+
+    # Get the URL ID
+    cursor = db_connection.cursor
+    cursor.execute("SELECT id FROM bookmarks WHERE url=?", (url,))
+    url_id = cursor.fetchone()[0]
+
+    # Delete the URL
+    result = db_connection.delete_url(url_id)
+    assert result == True
+
+    # Verify the URL and associated tags were deleted
+    cursor.execute("SELECT url FROM bookmarks WHERE id=?", (url_id,))
+    assert cursor.fetchone() is None
+
+def test_update_url_success(db_connection):
+    # Test updating an existing URL
+    db_connection.add_url("http://example.com")
+    
+    # Get the URL ID
+    cursor = db_connection.cursor
+    cursor.execute("SELECT id FROM bookmarks WHERE url=?", ("http://example.com",))
+    url_id = cursor.fetchone()[0]
+
+    # Update the URL
+    result = db_connection.update_url(url_id, "http://updated.com")
+    assert result == True
+
+    # Verify the URL was updated in the database
+    cursor.execute("SELECT url FROM bookmarks WHERE id=?", (url_id,))
+    assert cursor.fetchone()[0] == "http://updated.com"
+
+def test_search_url(db_connection):
+    # Test searching for URLs by tag or substring
+    db_connection.tag_url("http://example.com", "test")
+    db_connection.tag_url("http://example-test.org", "mytag")
+
+    # Search by tag 
+    results = db_connection.search_url("test")
+    assert len(results) == 1
+    assert results[0][1] == "http://example.com"
+
+    # Search by substring 
+    # (if given search value is tag and if it is available then it does not search in url substring)
+    results = db_connection.search_url("example")
+    assert len(results) == 2
+
+def test_open_url(db_connection, mocker):
+    # Test opening a URL in the browser
+    mocker.patch('builtins.input', return_value='yes')  # Mock user confirmation input
+    mocker.patch('webbrowser.open', return_value=True)  # Mock web browser opening
+
+    db_connection.add_url("http://example.com")
+    result = db_connection.open_url("example")
+    assert result == True

tests/test_readit.py

@@ -14,43 +14,34 @@ def test_version(runner):
     result = runner.invoke(c.main, ["--version"])
     assert not result.exception
     assert result.exit_code == 0
-    expected = "readit v0.3\n"
-    assert result.output == expected
+    # Check if version number is correctly outputted
+    assert "readit v0.3" in result.output
 
 
 # Testing -V option
 def test_by_version(runner):
     result = runner.invoke(c.main, ["-V"])
     assert not result.exception
     assert result.exit_code == 0
-    expected = "readit v0.3\n"
-    assert result.output == expected
-
+    # Check if version number is correctly outputted
+    assert "readit v0.3" in result.output
 
 # Testing --help option
 def test_help_option(runner):
-    """testing the help of readit"""
+    """Test the help output of the readit CLI tool"""
     result = runner.invoke(c.main, ["--help"])
-    assert not result.exception
     assert result.exit_code == 0
-    expected_output = (
-        "Usage: main [OPTIONS] [INSERT]...\n"
-        "\n"
-        "  Readit - Command-line bookmark manager tool."
-        "\n\n"
-        "Options:\n"
-        "  -a, --add TEXT...       Add URLs with space-separated\n"
-        "  -t, --tag TEXT...       Add Tag with space-separated URL\n"
-        "  -d, --delete TEXT       Remove a URL of particular ID\n"
-        "  -c, --clear TEXT...     Clear bookmarks\n"
-        "  -u, --update TEXT...    Update a URL for specific ID\n"
-        "  -s, --search TEXT       Search all bookmarks by Tag\n"
-        "  -v, --view TEXT...      Show bookmarks\n"
-        "  -o, --openurl TEXT      Open URL in Browser\n"
-        "  -V, --version           Check latest version\n"
-        "  -e, --export TEXT...    Export URLs in csv file\n"
-        "  -tl, --taglist TEXT...  Show all Tags\n"
-        "  -ui, --urlinfo TEXT     Check particular URL information\n"
-        "  --help                  Show this message and exit.\n"
-    )
-    assert result.output == expected_output
+    assert not result.exception
+
+    # Asserting key parts of the help message are present
+    assert "Usage: main [OPTIONS]" in result.output
+    assert "Readit - Command-line bookmark manager tool." in result.output
+    assert "-a, --add TEXT" in result.output
+    assert "-t, --tag TEXT" in result.output
+    assert "-V, --version" in result.output
+    assert "--help" in result.output
+
+    # Asserting information
+    assert "Options:" in result.output
+    assert "Show bookmarks" in result.output
+    assert "Add urls" in result.output