sql-testing-tools 0.2.4a0__tar.gz → 0.2.6__tar.gz

sql_testing_tools-0.2.6/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.2
+Name: sql_testing_tools
+Version: 0.2.6
+Description-Content-Type: text/markdown
+Requires-Dist: sqlparse>=0.5.1
+Requires-Dist: requests>=2.32.3
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+
+A library that normalizes simple SQL queries and compares them first by equality of the normalized string and then using the cosette API. 
+
+#### [Beta in Development!]
+ [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml)
+ [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml)
+
+- Submit bug reports and features requests at: https://github.com/ValentinHerrmann/sql_testing_tools
+- PyPi-Package available at: https://pypi.org/project/sql-testing-tools/ 
+
+
+## Getting started
+
+### Imports
+``` python
+# ensure to always use the latest version of sql_testing_tools
+import os
+os.system('pip install -U sql_testing_tools')
+
+# import sql_testing_tools
+import sql_testing_tools.BaseAccess as Ba
+import sql_testing_tools.Helper as He
+
+# import unittest and create TestClass
+import unittest 
+class TestClass(unittest.TestCase):
+    # Ba.setDBName(...)
+    # ...
+```
+
+### Choosing a database
+
+On top level of your test class, set the SQLite database you want to use. 
+
+**Option 1:** Use the predefined ones from [dbiu_databases](https://github.com/ValentinHerrmann/dbiu_databases) which are based on [datenbanken-im-unterricht.de](https://www.datenbanken-im-unterricht.de/catalog.php)
+
+``` python
+    # with DB name (preferred)
+    # --> only available if current dbiu_databases version has been imported to sql_testing_tools
+    Ba.setDBName("dbiu.bayern")
+
+    # or with dbiu_databases version number
+    # --> available as soon as a dbiu_databases version has been published on PyPi
+    Ba.setDBName(2) 
+```
+
+Currently supported to use with DB name are: 
+1. `dbiu.bahn`: https://www.dbiu.de/bahn
+2. `dbiu.bayern`: https://www.dbiu.de/bayern
+3. `dbiu.bundestag`: https://www.datenbanken-im-unterricht.de/downloads/bundestag.zip
+4. `dbiu.bundestag_einfach`: https://www.dbiu.de/bundestagsmitglieder
+5. `dbiu.film_fernsehen`: https://www.dbiu.de/filmundfernsehen
+6. `dbiu.haushaltsausstattung`: https://www.dbiu.de/haushaltsausstattung
+7. `dbiu.straftaten`: https://www.datenbanken-im-unterricht.de/downloads/kriminalstatistik-erweitert.zip
+8. `dbiu.straftaten_einfach`: https://www.dbiu.de/kriminalstatistik
+9. `dbiu.kunstsammlung`: https://www.dbiu.de/kunstsammlung
+10. `dbiu.ladepunkte`: https://www.dbiu.de/ladepunkte
+11. `dbiu.laenderspiele`: https://www.dbiu.de/laenderspiele
+12. `dbiu.lebensmittel`: https://www.dbiu.de/lebensmittel
+13. `dbiu.schulstatistik`: https://www.dbiu.de/schulstatistik
+14. `dbiu.studierende`: https://www.dbiu.de/studierende
+15. `dbiu.unfallstatistik`: https://www.dbiu.de/unfallstatistik
+16. `dbiu.videospiele_einfach`: https://www.dbiu.de/videospiele
+17. `dbiu.videospiele`: https://www.dbiu.de/videospiele2
+18. `dbiu.wetterdaten`: https://www.dbiu.de/wetterdaten
+
+**Option 2:** Use your own SQLite database with relative path starting at the working dir of your test repository.
+``` python
+    Ba.setDBName("databases/bayern.db")
+```
+
+### Available testing features
+
+The following methods are available for use in test methods:
+
+
+**Run the query to find out if syntax/database errors occur.**
+``` python
+try:
+    Ba.runAndGetStringTable_fromFile("sqlfile.sql")
+except Exception as e:
+    # the execution failed (usually due to syntax or database errors)
+    self.fail(e)
+```
+
+
+
+**Set sql files to be compared (optional).**
+The sql strings will  be normalized and used or all following methods (to improve performance) until new files are specified. All check...() functions call setup(...) as first step. If one argument is `""` or `None` the corresponding file is not changed. Therefore calling the check...() functions without arguments does not change the sql files that are compared.
+``` python
+# Raises an Exception if one of the files is empty. 
+setup("sqlfile.sql","solution.sql")
+```
+
+**Compared single parts of a sql query**
+Call without arguments to keep the last normalized sql strings (and improve performance) and with one or two sql file paths to load and normalize new queries. 
+Each check was successfull if `""` is returned. Returns a German error message if not. 
+Each method compares the normalized string between the start keyword and the next keyword or ;
+``` python
+
+res = He.checkColumns() # starts at "SELECT"
+res = He.checkTables() # starts at "FROM"
+res = He.checkCondition() # starts at "WHERE"
+res = He.checkOrder() # starts at "ORDER BY"
+res = He.checkGroup() # starts at "GROUP BY"
+```
+
+In special cases where you'd like to start and stop at individual keywords for comparison use this directly:
+``` python
+# Can not be called with new sql files. If needed call setup(...) before.
+res = checkKeywords("startKeyword",["end","keywords"]) 
+```
+
+Compares equality of the full normalized sql strings and if not equal uses the Cosette API (cosette.cs.washington.edu) for comparison. A file `cosette_apikey.txt` with only the apikey in it on root level of the test repository is required to use this feature. If not existant, only the string comparison is performed. *Warning: Cosette is currently not maintained!*
+
+``` python
+res = checkEquality()
+```
+
+
+
+
+
+
+
+
+
+### Changelog
+
+##### V 0.2.6
+- Fixed bug in checkKeywords: if keyword was present in one query and not in the other, the comparison was not performed correctly.
+
+##### V 0.2.5
+- Added support for [dbiu.de](https://www.datenbanken-im-unterricht.de/catalog.php) databases 1-18 (loaded via [dbiu_databases](https://github.com/ValentinHerrmann/dbiu_databases)) with option to still load DBs from local repo.
+- Improved docs
+
+##### V 0.2.4
+- Added more check methods for single parts of queries: checkColumns, checkTables, checkCondition, checkOrder, checkGroup, checkKeywords
+
+##### V 0.2.3
+- fix: ASC/DESC in ORDER BY (also with multiple columns and order directions), no direction treated as ASC
+- Verified that ; and whitespaces, linebreaks at end of query are ignored
+
+##### V 0.2.2 
+- Support LIKE
+- Support '<=' and '>=' (geq and leq)
+
+##### V 0.2.1
+- Support LIMIT
+  
+##### V 0.1.9 + 0.2.0
+- Support ORDER BY
+
+##### V 0.1.8
+- Fixed linebreak problems: Linebreaks are now converted into whitespaces before parsing where tokens
+
+##### V 0.1.6 + V 0.1.7
+- Fixed import error to ensure imports working in different environments
+
+##### V 0.1.4 + V 0.1.5
+- Chained conditions (with AND,OR and Paranthesises) in WHERE statement
+- Aggregate Functions
+
+##### V 0.1.3
+- SELECT: columns with our without table prefix
+- FROM: one or more table from DB; no queries as tables!
+- WHERE: single conditions; no Paranthesises!
+- GROUP BY one or more columns
+

sql_testing_tools-0.2.6/README.md

@@ -0,0 +1,168 @@
+A library that normalizes simple SQL queries and compares them first by equality of the normalized string and then using the cosette API. 
+
+#### [Beta in Development!]
+ [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml)
+ [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml)
+
+- Submit bug reports and features requests at: https://github.com/ValentinHerrmann/sql_testing_tools
+- PyPi-Package available at: https://pypi.org/project/sql-testing-tools/ 
+
+
+## Getting started
+
+### Imports
+``` python
+# ensure to always use the latest version of sql_testing_tools
+import os
+os.system('pip install -U sql_testing_tools')
+
+# import sql_testing_tools
+import sql_testing_tools.BaseAccess as Ba
+import sql_testing_tools.Helper as He
+
+# import unittest and create TestClass
+import unittest 
+class TestClass(unittest.TestCase):
+    # Ba.setDBName(...)
+    # ...
+```
+
+### Choosing a database
+
+On top level of your test class, set the SQLite database you want to use. 
+
+**Option 1:** Use the predefined ones from [dbiu_databases](https://github.com/ValentinHerrmann/dbiu_databases) which are based on [datenbanken-im-unterricht.de](https://www.datenbanken-im-unterricht.de/catalog.php)
+
+``` python
+    # with DB name (preferred)
+    # --> only available if current dbiu_databases version has been imported to sql_testing_tools
+    Ba.setDBName("dbiu.bayern")
+
+    # or with dbiu_databases version number
+    # --> available as soon as a dbiu_databases version has been published on PyPi
+    Ba.setDBName(2) 
+```
+
+Currently supported to use with DB name are: 
+1. `dbiu.bahn`: https://www.dbiu.de/bahn
+2. `dbiu.bayern`: https://www.dbiu.de/bayern
+3. `dbiu.bundestag`: https://www.datenbanken-im-unterricht.de/downloads/bundestag.zip
+4. `dbiu.bundestag_einfach`: https://www.dbiu.de/bundestagsmitglieder
+5. `dbiu.film_fernsehen`: https://www.dbiu.de/filmundfernsehen
+6. `dbiu.haushaltsausstattung`: https://www.dbiu.de/haushaltsausstattung
+7. `dbiu.straftaten`: https://www.datenbanken-im-unterricht.de/downloads/kriminalstatistik-erweitert.zip
+8. `dbiu.straftaten_einfach`: https://www.dbiu.de/kriminalstatistik
+9. `dbiu.kunstsammlung`: https://www.dbiu.de/kunstsammlung
+10. `dbiu.ladepunkte`: https://www.dbiu.de/ladepunkte
+11. `dbiu.laenderspiele`: https://www.dbiu.de/laenderspiele
+12. `dbiu.lebensmittel`: https://www.dbiu.de/lebensmittel
+13. `dbiu.schulstatistik`: https://www.dbiu.de/schulstatistik
+14. `dbiu.studierende`: https://www.dbiu.de/studierende
+15. `dbiu.unfallstatistik`: https://www.dbiu.de/unfallstatistik
+16. `dbiu.videospiele_einfach`: https://www.dbiu.de/videospiele
+17. `dbiu.videospiele`: https://www.dbiu.de/videospiele2
+18. `dbiu.wetterdaten`: https://www.dbiu.de/wetterdaten
+
+**Option 2:** Use your own SQLite database with relative path starting at the working dir of your test repository.
+``` python
+    Ba.setDBName("databases/bayern.db")
+```
+
+### Available testing features
+
+The following methods are available for use in test methods:
+
+
+**Run the query to find out if syntax/database errors occur.**
+``` python
+try:
+    Ba.runAndGetStringTable_fromFile("sqlfile.sql")
+except Exception as e:
+    # the execution failed (usually due to syntax or database errors)
+    self.fail(e)
+```
+
+
+
+**Set sql files to be compared (optional).**
+The sql strings will  be normalized and used or all following methods (to improve performance) until new files are specified. All check...() functions call setup(...) as first step. If one argument is `""` or `None` the corresponding file is not changed. Therefore calling the check...() functions without arguments does not change the sql files that are compared.
+``` python
+# Raises an Exception if one of the files is empty. 
+setup("sqlfile.sql","solution.sql")
+```
+
+**Compared single parts of a sql query**
+Call without arguments to keep the last normalized sql strings (and improve performance) and with one or two sql file paths to load and normalize new queries. 
+Each check was successfull if `""` is returned. Returns a German error message if not. 
+Each method compares the normalized string between the start keyword and the next keyword or ;
+``` python
+
+res = He.checkColumns() # starts at "SELECT"
+res = He.checkTables() # starts at "FROM"
+res = He.checkCondition() # starts at "WHERE"
+res = He.checkOrder() # starts at "ORDER BY"
+res = He.checkGroup() # starts at "GROUP BY"
+```
+
+In special cases where you'd like to start and stop at individual keywords for comparison use this directly:
+``` python
+# Can not be called with new sql files. If needed call setup(...) before.
+res = checkKeywords("startKeyword",["end","keywords"]) 
+```
+
+Compares equality of the full normalized sql strings and if not equal uses the Cosette API (cosette.cs.washington.edu) for comparison. A file `cosette_apikey.txt` with only the apikey in it on root level of the test repository is required to use this feature. If not existant, only the string comparison is performed. *Warning: Cosette is currently not maintained!*
+
+``` python
+res = checkEquality()
+```
+
+
+
+
+
+
+
+
+
+### Changelog
+
+##### V 0.2.6
+- Fixed bug in checkKeywords: if keyword was present in one query and not in the other, the comparison was not performed correctly.
+
+##### V 0.2.5
+- Added support for [dbiu.de](https://www.datenbanken-im-unterricht.de/catalog.php) databases 1-18 (loaded via [dbiu_databases](https://github.com/ValentinHerrmann/dbiu_databases)) with option to still load DBs from local repo.
+- Improved docs
+
+##### V 0.2.4
+- Added more check methods for single parts of queries: checkColumns, checkTables, checkCondition, checkOrder, checkGroup, checkKeywords
+
+##### V 0.2.3
+- fix: ASC/DESC in ORDER BY (also with multiple columns and order directions), no direction treated as ASC
+- Verified that ; and whitespaces, linebreaks at end of query are ignored
+
+##### V 0.2.2 
+- Support LIKE
+- Support '<=' and '>=' (geq and leq)
+
+##### V 0.2.1
+- Support LIMIT
+  
+##### V 0.1.9 + 0.2.0
+- Support ORDER BY
+
+##### V 0.1.8
+- Fixed linebreak problems: Linebreaks are now converted into whitespaces before parsing where tokens
+
+##### V 0.1.6 + V 0.1.7
+- Fixed import error to ensure imports working in different environments
+
+##### V 0.1.4 + V 0.1.5
+- Chained conditions (with AND,OR and Paranthesises) in WHERE statement
+- Aggregate Functions
+
+##### V 0.1.3
+- SELECT: columns with our without table prefix
+- FROM: one or more table from DB; no queries as tables!
+- WHERE: single conditions; no Paranthesises!
+- GROUP BY one or more columns
+

sql_testing_tools-0.2.6/setup.py

@@ -0,0 +1,17 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r") as fh:
+    description = fh.read()
+
+
+setup(
+    name='sql_testing_tools',
+    version='0.2.6',
+    packages=find_packages(),
+    install_requires=[
+        'sqlparse>=0.5.1',
+        'requests>=2.32.3'
+    ],
+    long_description=description,
+    long_description_content_type="text/markdown"
+)

{sql_testing_tools-0.2.4a0 → sql_testing_tools-0.2.6}/sql_testing_tools/BaseAccess.py

@@ -3,51 +3,68 @@ import os
 import importlib
 
 
-__db=""
 
-def setDBName(path: str):
-    global __db
-    print("Setting DB to: " + path)
-    __db = path
+dbMap = {
+    "dbiu.bahn":1,
+    "dbiu.bayern":2,
+    "dbiu.bundestag": 3,
+    "dbiu.bundestag_einfach": 4,
+    "dbiu.film_fernsehen": 5,
+    "dbiu.haushaltsausstattung": 6,
+    "dbiu.straftaten": 7,
+    "dbiu.straftaten_einfach": 8,
+    "dbiu.kunstsammlung": 9,
+    "dbiu.ladepunkte": 10,
+    "dbiu.laenderspiele": 11,
+    "dbiu.lebensmittel": 12,
+    "dbiu.schulstatistik": 13,
+    "dbiu.studierende": 14,
+    "dbiu.unfallstatistik": 15,
+    "dbiu.videospiele_einfach": 16,
+    "dbiu.videospiele": 17,
+    "dbiu.wetterdaten": 18
+}
 
-def checkDbInResources():
-    global __db
-
-    resources = list(importlib.resources.contents('sql_testing_tools.databases'))
-    print("Available resources: " + str(resources))
+__db=""
 
-    newPath = __db.replace("databases/","") 
+def setDBName(database):
+    global __db
 
-    if(newPath not in resources):
-        print("Database not in resources. Trying to find '"+ __db +"' in the current directory.")
-        for root, dirs, files in os.walk('.'):
-            for file in files:
-                f = os.path.join(root, file)
-                print(f)
-                if f.endswith(newPath):
-                    print("Database found in current directory.")
-                    return False
+    if isinstance(database, str) and database.startswith("dbiu."):
+        dbVersion = dbMap.get(database)
+    elif isinstance(database, int):
+        dbVersion = database
+        database = "dbiu."+str(database)
+    elif isinstance(database, str):
+        dbVersion = None
     else:
-        print("Database found in resources.")
-        __db = newPath
-        return True
-
-
+        raise Exception("Invalid database selected")
+        
+    if(dbVersion is not None):
+        os.system('pip install dbiu_databases=='+str(dbVersion))
+        try:
+            import dbiu_databases
+        except ImportError:
+            raise Exception("Invalid database selected")
+    print("Setting DB to: " + database)
+    __db = database
+
+    
 def run(sql: str):
     global __db
-    if checkDbInResources():
-        with importlib.resources.path('sql_testing_tools.databases', __db) as db_path:
-            with sqlite3.connect(db_path) as con:
-                cur = con.cursor()
-                cur.execute(sql)
-                con.commit()
-                return cur
+
+    if __db.startswith("dbiu.") and not __db.endswith(".db"):
+        with importlib.resources.path('dbiu_databases', "base.db") as db_path:
+            return __run(sql, db_path)
     else:
-        with sqlite3.connect(__db) as con:
-            cur = con.cursor()
-            cur.execute(sql)
-            con.commit()
-            return cur
+        return __run(sql, __db)
+
+def __run(sql: str, db: str):
+    with sqlite3.connect(db) as con:
+        cur = con.cursor()
+        cur.execute(sql)
+        con.commit()
+        return cur
 
 def runFromFile(path: str):
     sql = getSQLFromFile(path)

{sql_testing_tools-0.2.4a0 → sql_testing_tools-0.2.6}/sql_testing_tools/Helper.py

@@ -152,7 +152,7 @@ def buildAndSendCosetteRequest(baseDict, sql, sol):
 def checkKeywords(startWord:str, endWords:list):
     global sql,sol
 
-    if(startWord not in sol or startWord not in sql):
+    if(startWord not in sol and startWord not in sql):
         return ""
 
     if(startWord in sql):
@@ -186,119 +186,30 @@ def checkKeywords(startWord:str, endWords:list):
     return "Der '"+startWord+"' Teil der SQL-Abfrage ist nicht korrekt (oder nicht automatisch überprüfbar)."
 
 
-
-
 def checkColumns(sqlPath="", solPath=""):
     global sql,sol
     setup(sqlPath, solPath)
     return checkKeywords("SELECT", ["FROM", "WHERE", "GROUP BY", "ORDER BY", "LIMIT", ";", "HAVING"])
 
 
-
-
-    if("SELECT" in sql and "FROM" in sql):
-        start = str.find(sql, "SELECT")
-        end = str.find(sql, "FROM")
-        submission = str.strip(sql[start:end])
-        print("'"+submission+"'")
-
-        start = str.find(sol, "SELECT")
-        end = str.find(sol, "FROM")
-        solution = str.strip(sol[start:end])
-        print("'"+solution+"'")
-
-        if submission == solution:
-            return ""
-    return "Ausgegebene Spalten sind nicht korrekt (oder nicht automatisch überprüfbar)."
-
 def checkTables(sqlPath="", solPath=""):
     global sql,sol
     setup(sqlPath, solPath)
     return checkKeywords("FROM", ["FROM", "WHERE", "GROUP BY", "ORDER BY", "LIMIT", ";", "HAVING"])
 
 
-
-
-    if("SELECT" in sql and "FROM" in sql):
-        endFromKeywords = ["WHERE", "GROUP", "ORDER", "LIMIT", ";"]
-
-        start = str.find(sql, "FROM")
-        end = -1
-
-
-        for keyword in endFromKeywords:
-            if(str.find(sql, keyword) != -1):
-                end = str.find(sql, keyword)
-                break
-        if(end == -1):
-            end = len(sql)
-
-        submission = str.strip(sql[start:end])
-        print("'"+submission+"'")
-
-        start = str.find(sol, "FROM")
-        end = -1
-        
-        for keyword in endFromKeywords:
-            if(str.find(sol, keyword) != -1):
-                end = str.find(sol, keyword)
-                break
-        if(end == -1):
-            end = len(sol)
-
-        solution = str.strip(sol[start:end])
-        print("'"+solution+"'")
-
-        if submission == solution:
-            return ""
-    return "Verwendete Tabellen sind nicht korrekt (oder nicht automatisch überprüfbar)."
-
 def checkCondition(sqlPath="", solPath=""):
     global sql,sol
     setup(sqlPath, solPath)
     return checkKeywords("WHERE", ["GROUP BY", "ORDER BY", "LIMIT", ";", "HAVING"])
 
+
 def checkOrder(sqlPath="", solPath=""):
     global sql,sol
     setup(sqlPath, solPath)
     return checkKeywords("ORDER BY", ["WHERE", "GROUP BY", "ORDER BY", "LIMIT", ";", "HAVING"])
 
 
-
-    if("ORDER BY" in sql):
-        endFromKeywords = ["WHERE", "GROUP", "LIMIT", ";"]
-
-        start = str.find(sql, "ORDER BY")
-        end = -1
-
-
-        for keyword in endFromKeywords:
-            if(str.find(sql, keyword) != -1):
-                end = str.find(sql, keyword)
-                break
-        if(end == -1):
-            end = len(sql)
-
-        submission = str.strip(sql[start:end])
-        print("'"+submission+"'")
-
-        start = str.find(sol, "ORDER BY")
-        end = -1
-        
-        for keyword in endFromKeywords:
-            if(str.find(sol, keyword) != -1):
-                end = str.find(sol, keyword)
-                break
-        if(end == -1):
-            end = len(sol)
-
-        solution = str.strip(sol[start:end])
-        print("'"+solution+"'")
-
-        if submission == solution:
-            return ""
-    return "Die Sortierung ist nicht korrekt (oder nicht automatisch überprüfbar)."
-
 def checkGroup(sqlPath="", solPath=""):
     global sql,sol
     setup(sqlPath, solPath)
@@ -306,17 +217,17 @@ def checkGroup(sqlPath="", solPath=""):
 
 
 def checkEquality(sqlPath="", solPath=""):
-    global sql,sol
+    global sql, sol
     setup(sqlPath, solPath)
 
-    if(sql==sol):
+    if sql == sol:
         return ""
 
     result = buildAndSendCosetteRequest(bd, sql, sol)
 
-    if(result[0] == "ERR"):
+    if result[0] == "ERR":
         return "\n\nFehler bei der automatischen Überprüfung der Abgabe. Es kann keine Aussage über die Korrektheit der Abgabe getroffen werden."
-    elif(result[0] != "EQ"):
+    elif result[0] != "EQ":
         return "\n\nDie Abgabe stimmt nicht mit der Musterlösung überein."
     return ""
 

sql_testing_tools-0.2.6/sql_testing_tools.egg-info/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.2
+Name: sql_testing_tools
+Version: 0.2.6
+Description-Content-Type: text/markdown
+Requires-Dist: sqlparse>=0.5.1
+Requires-Dist: requests>=2.32.3
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+
+A library that normalizes simple SQL queries and compares them first by equality of the normalized string and then using the cosette API. 
+
+#### [Beta in Development!]
+ [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml)
+ [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml)
+
+- Submit bug reports and features requests at: https://github.com/ValentinHerrmann/sql_testing_tools
+- PyPi-Package available at: https://pypi.org/project/sql-testing-tools/ 
+
+
+## Getting started
+
+### Imports
+``` python
+# ensure to always use the latest version of sql_testing_tools
+import os
+os.system('pip install -U sql_testing_tools')
+
+# import sql_testing_tools
+import sql_testing_tools.BaseAccess as Ba
+import sql_testing_tools.Helper as He
+
+# import unittest and create TestClass
+import unittest 
+class TestClass(unittest.TestCase):
+    # Ba.setDBName(...)
+    # ...
+```
+
+### Choosing a database
+
+On top level of your test class, set the SQLite database you want to use. 
+
+**Option 1:** Use the predefined ones from [dbiu_databases](https://github.com/ValentinHerrmann/dbiu_databases) which are based on [datenbanken-im-unterricht.de](https://www.datenbanken-im-unterricht.de/catalog.php)
+
+``` python
+    # with DB name (preferred)
+    # --> only available if current dbiu_databases version has been imported to sql_testing_tools
+    Ba.setDBName("dbiu.bayern")
+
+    # or with dbiu_databases version number
+    # --> available as soon as a dbiu_databases version has been published on PyPi
+    Ba.setDBName(2) 
+```
+
+Currently supported to use with DB name are: 
+1. `dbiu.bahn`: https://www.dbiu.de/bahn
+2. `dbiu.bayern`: https://www.dbiu.de/bayern
+3. `dbiu.bundestag`: https://www.datenbanken-im-unterricht.de/downloads/bundestag.zip
+4. `dbiu.bundestag_einfach`: https://www.dbiu.de/bundestagsmitglieder
+5. `dbiu.film_fernsehen`: https://www.dbiu.de/filmundfernsehen
+6. `dbiu.haushaltsausstattung`: https://www.dbiu.de/haushaltsausstattung
+7. `dbiu.straftaten`: https://www.datenbanken-im-unterricht.de/downloads/kriminalstatistik-erweitert.zip
+8. `dbiu.straftaten_einfach`: https://www.dbiu.de/kriminalstatistik
+9. `dbiu.kunstsammlung`: https://www.dbiu.de/kunstsammlung
+10. `dbiu.ladepunkte`: https://www.dbiu.de/ladepunkte
+11. `dbiu.laenderspiele`: https://www.dbiu.de/laenderspiele
+12. `dbiu.lebensmittel`: https://www.dbiu.de/lebensmittel
+13. `dbiu.schulstatistik`: https://www.dbiu.de/schulstatistik
+14. `dbiu.studierende`: https://www.dbiu.de/studierende
+15. `dbiu.unfallstatistik`: https://www.dbiu.de/unfallstatistik
+16. `dbiu.videospiele_einfach`: https://www.dbiu.de/videospiele
+17. `dbiu.videospiele`: https://www.dbiu.de/videospiele2
+18. `dbiu.wetterdaten`: https://www.dbiu.de/wetterdaten
+
+**Option 2:** Use your own SQLite database with relative path starting at the working dir of your test repository.
+``` python
+    Ba.setDBName("databases/bayern.db")
+```
+
+### Available testing features
+
+The following methods are available for use in test methods:
+
+
+**Run the query to find out if syntax/database errors occur.**
+``` python
+try:
+    Ba.runAndGetStringTable_fromFile("sqlfile.sql")
+except Exception as e:
+    # the execution failed (usually due to syntax or database errors)
+    self.fail(e)
+```
+
+
+
+**Set sql files to be compared (optional).**
+The sql strings will  be normalized and used or all following methods (to improve performance) until new files are specified. All check...() functions call setup(...) as first step. If one argument is `""` or `None` the corresponding file is not changed. Therefore calling the check...() functions without arguments does not change the sql files that are compared.
+``` python
+# Raises an Exception if one of the files is empty. 
+setup("sqlfile.sql","solution.sql")
+```
+
+**Compared single parts of a sql query**
+Call without arguments to keep the last normalized sql strings (and improve performance) and with one or two sql file paths to load and normalize new queries. 
+Each check was successfull if `""` is returned. Returns a German error message if not. 
+Each method compares the normalized string between the start keyword and the next keyword or ;
+``` python
+
+res = He.checkColumns() # starts at "SELECT"
+res = He.checkTables() # starts at "FROM"
+res = He.checkCondition() # starts at "WHERE"
+res = He.checkOrder() # starts at "ORDER BY"
+res = He.checkGroup() # starts at "GROUP BY"
+```
+
+In special cases where you'd like to start and stop at individual keywords for comparison use this directly:
+``` python
+# Can not be called with new sql files. If needed call setup(...) before.
+res = checkKeywords("startKeyword",["end","keywords"]) 
+```
+
+Compares equality of the full normalized sql strings and if not equal uses the Cosette API (cosette.cs.washington.edu) for comparison. A file `cosette_apikey.txt` with only the apikey in it on root level of the test repository is required to use this feature. If not existant, only the string comparison is performed. *Warning: Cosette is currently not maintained!*
+
+``` python
+res = checkEquality()
+```
+
+
+
+
+
+
+
+
+
+### Changelog
+
+##### V 0.2.6
+- Fixed bug in checkKeywords: if keyword was present in one query and not in the other, the comparison was not performed correctly.
+
+##### V 0.2.5
+- Added support for [dbiu.de](https://www.datenbanken-im-unterricht.de/catalog.php) databases 1-18 (loaded via [dbiu_databases](https://github.com/ValentinHerrmann/dbiu_databases)) with option to still load DBs from local repo.
+- Improved docs
+
+##### V 0.2.4
+- Added more check methods for single parts of queries: checkColumns, checkTables, checkCondition, checkOrder, checkGroup, checkKeywords
+
+##### V 0.2.3
+- fix: ASC/DESC in ORDER BY (also with multiple columns and order directions), no direction treated as ASC
+- Verified that ; and whitespaces, linebreaks at end of query are ignored
+
+##### V 0.2.2 
+- Support LIKE
+- Support '<=' and '>=' (geq and leq)
+
+##### V 0.2.1
+- Support LIMIT
+  
+##### V 0.1.9 + 0.2.0
+- Support ORDER BY
+
+##### V 0.1.8
+- Fixed linebreak problems: Linebreaks are now converted into whitespaces before parsing where tokens
+
+##### V 0.1.6 + V 0.1.7
+- Fixed import error to ensure imports working in different environments
+
+##### V 0.1.4 + V 0.1.5
+- Chained conditions (with AND,OR and Paranthesises) in WHERE statement
+- Aggregate Functions
+
+##### V 0.1.3
+- SELECT: columns with our without table prefix
+- FROM: one or more table from DB; no queries as tables!
+- WHERE: single conditions; no Paranthesises!
+- GROUP BY one or more columns
+

sql_testing_tools-0.2.4a0/PKG-INFO

@@ -1,127 +0,0 @@
-Metadata-Version: 2.2
-Name: sql_testing_tools
-Version: 0.2.4a0
-Description-Content-Type: text/markdown
-Requires-Dist: sqlparse>=0.5.1
-Requires-Dist: requests>=2.32.3
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: requires-dist
-
-A library that normalizes simple SQL queries and compares them first by equality of the normalized string and then using the cosette API. 
-
-### [Beta in Development!]
- [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml)
- [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml)
-
-- Submit bug reports and features requests at: https://github.com/ValentinHerrmann/sql_testing_tools
-- PyPi-Package available at: https://pypi.org/project/sql-testing-tools/ 
-
-
-
-### Getting started
-
-Use the following code to import the SQL Testing Tools to your project:
-``` python
-# ensure to always use the latest version of sql_testing_tools
-import os
-os.system('pip install -U sql_testing_tools')
-
-# import sql_testing_tools
-import sql_testing_tools.BaseAccess as Ba
-import sql_testing_tools.Helper as He
-```
-
-On global level of your test class, set the SQLite database you want to use (bases must be located in the repository of the test class, no DBs contained in sql_testing_tools).
-``` python
-import unittest 
-class TestClass(unittest.TestCase):
-    Ba.setDBName("databases/ladepunkte.db") 
-```
-
-The following methods are available for use in test methods:
-``` python
-try:
-    Ba.runAndGetStringTable_fromFile("sqlfile.sql")
-except Exception as e:
-    # the execution failed 
-    # (usually due to syntax or database errors)
-    self.fail(e)
-
-# (optional) set the files to be compared. The sql strings will 
-# be normalized and used for all following methods (to improve 
-# performance), until new  files are set. Arguments that are
-# None or "" are ignored and the sql string remains the same.
-# Raises an Exception if one of the files is empty.
-setup("sqlfile.sql","solution.sql")
-
-# All following methods call setup(sql,sol) before executing 
-# anything else. Call without arguments to keep the last 
-# normalized sql strings (and improve performance).
-# Each check was successfull if "" is returned. Returns a 
-# German error message if not.
-# Each method compares the normalized string between the start
-# keyword and the next keyword or ;
-
-res = He.checkColumns() # starts to search at keyword "SELECT"
-res = He.checkTables() # starts to search at keyword "FROM"
-res = He.checkCondition() # starts to search at keyword "WHERE"
-res = He.checkOrder() # starts to search at keyword "ORDER BY"
-res = He.checkGroup() # starts to search at keyword "GROUP BY"
-
-# can not be called with new sql files
-res = checkKeywords("startKeyword",["end","keywords"]) 
-
-# compares equality of the full normalized sql strings and if 
-# not equal uses the Cosette API (cosette.cs.washington.edu)
-# for comparison. A file 'cosette_apikey.txt' with only the 
-# apikey in it on root level of the test repository is required 
-# to use this feature. If not existant, only the string comparison
-# is performed.
-# Warning: Cosette is not maintained!
-res = checkEquality()
-```
-
-
-
-
-
-
-
-
-
-### Changelog
-
-##### V0.2.4
-- Added more check methods for single parts of queries: checkColumns, checkTables, checkCondition, checkOrder, checkGroup, checkKeywords
-
-##### V 0.2.3
-- fix: ASC/DESC in ORDER BY (also with multiple columns and order directions), no direction treated as ASC
-- Verified that ; and whitespaces, linebreaks at end of query are ignored
-
-##### V 0.2.2 
-- Support LIKE
-- Support '<=' and '>=' (geq and leq)
-
-##### V 0.2.1
-- Support LIMIT
-  
-##### V 0.1.9 + 0.2.0
-- Support ORDER BY
-
-##### V 0.1.8
-- Fixed linebreak problems: Linebreaks are now converted into whitespaces before parsing where tokens
-
-##### V 0.1.6 + V 0.1.7
-- Fixed import error to ensure imports working in different environments
-
-##### V 0.1.4 + V 0.1.5
-- Chained conditions (with AND,OR and Paranthesises) in WHERE statement
-- Aggregate Functions
-
-##### V 0.1.3
-- SELECT: columns with our without table prefix
-- FROM: one or more table from DB; no queries as tables!
-- WHERE: single conditions; no Paranthesises!
-- GROUP BY one or more columns
-

sql_testing_tools-0.2.4a0/README.md

@@ -1,117 +0,0 @@
-A library that normalizes simple SQL queries and compares them first by equality of the normalized string and then using the cosette API. 
-
-### [Beta in Development!]
- [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml)
- [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml)
-
-- Submit bug reports and features requests at: https://github.com/ValentinHerrmann/sql_testing_tools
-- PyPi-Package available at: https://pypi.org/project/sql-testing-tools/ 
-
-
-
-### Getting started
-
-Use the following code to import the SQL Testing Tools to your project:
-``` python
-# ensure to always use the latest version of sql_testing_tools
-import os
-os.system('pip install -U sql_testing_tools')
-
-# import sql_testing_tools
-import sql_testing_tools.BaseAccess as Ba
-import sql_testing_tools.Helper as He
-```
-
-On global level of your test class, set the SQLite database you want to use (bases must be located in the repository of the test class, no DBs contained in sql_testing_tools).
-``` python
-import unittest 
-class TestClass(unittest.TestCase):
-    Ba.setDBName("databases/ladepunkte.db") 
-```
-
-The following methods are available for use in test methods:
-``` python
-try:
-    Ba.runAndGetStringTable_fromFile("sqlfile.sql")
-except Exception as e:
-    # the execution failed 
-    # (usually due to syntax or database errors)
-    self.fail(e)
-
-# (optional) set the files to be compared. The sql strings will 
-# be normalized and used for all following methods (to improve 
-# performance), until new  files are set. Arguments that are
-# None or "" are ignored and the sql string remains the same.
-# Raises an Exception if one of the files is empty.
-setup("sqlfile.sql","solution.sql")
-
-# All following methods call setup(sql,sol) before executing 
-# anything else. Call without arguments to keep the last 
-# normalized sql strings (and improve performance).
-# Each check was successfull if "" is returned. Returns a 
-# German error message if not.
-# Each method compares the normalized string between the start
-# keyword and the next keyword or ;
-
-res = He.checkColumns() # starts to search at keyword "SELECT"
-res = He.checkTables() # starts to search at keyword "FROM"
-res = He.checkCondition() # starts to search at keyword "WHERE"
-res = He.checkOrder() # starts to search at keyword "ORDER BY"
-res = He.checkGroup() # starts to search at keyword "GROUP BY"
-
-# can not be called with new sql files
-res = checkKeywords("startKeyword",["end","keywords"]) 
-
-# compares equality of the full normalized sql strings and if 
-# not equal uses the Cosette API (cosette.cs.washington.edu)
-# for comparison. A file 'cosette_apikey.txt' with only the 
-# apikey in it on root level of the test repository is required 
-# to use this feature. If not existant, only the string comparison
-# is performed.
-# Warning: Cosette is not maintained!
-res = checkEquality()
-```
-
-
-
-
-
-
-
-
-
-### Changelog
-
-##### V0.2.4
-- Added more check methods for single parts of queries: checkColumns, checkTables, checkCondition, checkOrder, checkGroup, checkKeywords
-
-##### V 0.2.3
-- fix: ASC/DESC in ORDER BY (also with multiple columns and order directions), no direction treated as ASC
-- Verified that ; and whitespaces, linebreaks at end of query are ignored
-
-##### V 0.2.2 
-- Support LIKE
-- Support '<=' and '>=' (geq and leq)
-
-##### V 0.2.1
-- Support LIMIT
-  
-##### V 0.1.9 + 0.2.0
-- Support ORDER BY
-
-##### V 0.1.8
-- Fixed linebreak problems: Linebreaks are now converted into whitespaces before parsing where tokens
-
-##### V 0.1.6 + V 0.1.7
-- Fixed import error to ensure imports working in different environments
-
-##### V 0.1.4 + V 0.1.5
-- Chained conditions (with AND,OR and Paranthesises) in WHERE statement
-- Aggregate Functions
-
-##### V 0.1.3
-- SELECT: columns with our without table prefix
-- FROM: one or more table from DB; no queries as tables!
-- WHERE: single conditions; no Paranthesises!
-- GROUP BY one or more columns
-

sql_testing_tools-0.2.4a0/setup.py

@@ -1,27 +0,0 @@
-from setuptools import setup, find_packages
-
-with open("README.md", "r") as fh:
-    description = fh.read()
-
-
-setup(
-    name='sql_testing_tools',
-    version='0.2.4.a',
-    packages=find_packages(),
-    install_requires=[
-        'sqlparse>=0.5.1',
-        'requests>=2.32.3'
-    ],
-    long_description=description,
-    long_description_content_type="text/markdown",
-    package_data={
-        'sql_testing_tools.databases': [
-            'databases/*.db'#, 
-            #'./databases/bayern.db', 
-            #'./databases/film_fernsehen.db',
-            #'./databases/ladepunkte.db',
-            #'./databases/straftaten.db',
-            ]
-    },
-    include_package_data=True
-)

sql_testing_tools-0.2.4a0/sql_testing_tools.egg-info/PKG-INFO

@@ -1,127 +0,0 @@
-Metadata-Version: 2.2
-Name: sql_testing_tools
-Version: 0.2.4a0
-Description-Content-Type: text/markdown
-Requires-Dist: sqlparse>=0.5.1
-Requires-Dist: requests>=2.32.3
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: requires-dist
-
-A library that normalizes simple SQL queries and compares them first by equality of the normalized string and then using the cosette API. 
-
-### [Beta in Development!]
- [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-build.yml)
- [![Build and Test](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/ValentinHerrmann/sql_testing_tools/actions/workflows/python-unittests.yml)
-
-- Submit bug reports and features requests at: https://github.com/ValentinHerrmann/sql_testing_tools
-- PyPi-Package available at: https://pypi.org/project/sql-testing-tools/ 
-
-
-
-### Getting started
-
-Use the following code to import the SQL Testing Tools to your project:
-``` python
-# ensure to always use the latest version of sql_testing_tools
-import os
-os.system('pip install -U sql_testing_tools')
-
-# import sql_testing_tools
-import sql_testing_tools.BaseAccess as Ba
-import sql_testing_tools.Helper as He
-```
-
-On global level of your test class, set the SQLite database you want to use (bases must be located in the repository of the test class, no DBs contained in sql_testing_tools).
-``` python
-import unittest 
-class TestClass(unittest.TestCase):
-    Ba.setDBName("databases/ladepunkte.db") 
-```
-
-The following methods are available for use in test methods:
-``` python
-try:
-    Ba.runAndGetStringTable_fromFile("sqlfile.sql")
-except Exception as e:
-    # the execution failed 
-    # (usually due to syntax or database errors)
-    self.fail(e)
-
-# (optional) set the files to be compared. The sql strings will 
-# be normalized and used for all following methods (to improve 
-# performance), until new  files are set. Arguments that are
-# None or "" are ignored and the sql string remains the same.
-# Raises an Exception if one of the files is empty.
-setup("sqlfile.sql","solution.sql")
-
-# All following methods call setup(sql,sol) before executing 
-# anything else. Call without arguments to keep the last 
-# normalized sql strings (and improve performance).
-# Each check was successfull if "" is returned. Returns a 
-# German error message if not.
-# Each method compares the normalized string between the start
-# keyword and the next keyword or ;
-
-res = He.checkColumns() # starts to search at keyword "SELECT"
-res = He.checkTables() # starts to search at keyword "FROM"
-res = He.checkCondition() # starts to search at keyword "WHERE"
-res = He.checkOrder() # starts to search at keyword "ORDER BY"
-res = He.checkGroup() # starts to search at keyword "GROUP BY"
-
-# can not be called with new sql files
-res = checkKeywords("startKeyword",["end","keywords"]) 
-
-# compares equality of the full normalized sql strings and if 
-# not equal uses the Cosette API (cosette.cs.washington.edu)
-# for comparison. A file 'cosette_apikey.txt' with only the 
-# apikey in it on root level of the test repository is required 
-# to use this feature. If not existant, only the string comparison
-# is performed.
-# Warning: Cosette is not maintained!
-res = checkEquality()
-```
-
-
-
-
-
-
-
-
-
-### Changelog
-
-##### V0.2.4
-- Added more check methods for single parts of queries: checkColumns, checkTables, checkCondition, checkOrder, checkGroup, checkKeywords
-
-##### V 0.2.3
-- fix: ASC/DESC in ORDER BY (also with multiple columns and order directions), no direction treated as ASC
-- Verified that ; and whitespaces, linebreaks at end of query are ignored
-
-##### V 0.2.2 
-- Support LIKE
-- Support '<=' and '>=' (geq and leq)
-
-##### V 0.2.1
-- Support LIMIT
-  
-##### V 0.1.9 + 0.2.0
-- Support ORDER BY
-
-##### V 0.1.8
-- Fixed linebreak problems: Linebreaks are now converted into whitespaces before parsing where tokens
-
-##### V 0.1.6 + V 0.1.7
-- Fixed import error to ensure imports working in different environments
-
-##### V 0.1.4 + V 0.1.5
-- Chained conditions (with AND,OR and Paranthesises) in WHERE statement
-- Aggregate Functions
-
-##### V 0.1.3
-- SELECT: columns with our without table prefix
-- FROM: one or more table from DB; no queries as tables!
-- WHERE: single conditions; no Paranthesises!
-- GROUP BY one or more columns
-