Move test_utils out of library

Previously the test_utils were part of the public API (albeit their
documentation was hidden), so that they could be used by a single unit
test. Since the unit test only used public APIs, we can just move it
to the integration tests, allowing us to outsource the test_utils.

Author: not-my-profile

src/lib.rs

@@ -45,9 +45,3 @@ pub mod dialect;
 pub mod keywords;
 pub mod parser;
 pub mod tokenizer;
-
-#[doc(hidden)]
-// This is required to make utilities accessible by both the crate-internal
-// unit-tests and by the integration tests <https://stackoverflow.com/a/44541071/1026>
-// External users are not supposed to rely on this module.
-pub mod test_utils;

src/parser.rs

@@ -3629,30 +3629,3 @@ impl Word {
         }
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use crate::test_utils::all_dialects;
-
-    #[test]
-    fn test_prev_index() {
-        let sql = "SELECT version";
-        all_dialects().run_parser_method(sql, |parser| {
-            assert_eq!(parser.peek_token(), Token::make_keyword("SELECT"));
-            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
-            parser.prev_token();
-            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
-            assert_eq!(parser.next_token(), Token::make_word("version", None));
-            parser.prev_token();
-            assert_eq!(parser.peek_token(), Token::make_word("version", None));
-            assert_eq!(parser.next_token(), Token::make_word("version", None));
-            assert_eq!(parser.peek_token(), Token::EOF);
-            parser.prev_token();
-            assert_eq!(parser.next_token(), Token::make_word("version", None));
-            assert_eq!(parser.next_token(), Token::EOF);
-            assert_eq!(parser.next_token(), Token::EOF);
-            parser.prev_token();
-        });
-    }
-}

tests/sqlparser_common.rs

@@ -25,10 +25,32 @@ use sqlparser::ast::*;
 use sqlparser::dialect::{GenericDialect, PostgreSqlDialect, SQLiteDialect};
 use sqlparser::keywords::ALL_KEYWORDS;
 use sqlparser::parser::{Parser, ParserError};
+use sqlparser::tokenizer::Token;
 use test_utils::{
     all_dialects, expr_from_projection, join, number, only, table, table_alias, TestedDialects,
 };
 
+#[test]
+fn test_prev_index() {
+    let sql = "SELECT version";
+    all_dialects().run_parser_method(sql, |parser| {
+        assert_eq!(parser.peek_token(), Token::make_keyword("SELECT"));
+        assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
+        parser.prev_token();
+        assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
+        assert_eq!(parser.next_token(), Token::make_word("version", None));
+        parser.prev_token();
+        assert_eq!(parser.peek_token(), Token::make_word("version", None));
+        assert_eq!(parser.next_token(), Token::make_word("version", None));
+        assert_eq!(parser.peek_token(), Token::EOF);
+        parser.prev_token();
+        assert_eq!(parser.next_token(), Token::make_word("version", None));
+        assert_eq!(parser.next_token(), Token::EOF);
+        assert_eq!(parser.next_token(), Token::EOF);
+        parser.prev_token();
+    });
+}
+
 #[test]
 fn parse_insert_values() {
     let row = vec![

tests/sqlparser_hive.rs

@@ -15,8 +15,10 @@
 //! Test SQL syntax specific to Hive. The parser based on the generic dialect
 //! is also tested (on the inputs it can handle).
 
+mod test_utils;
+
 use sqlparser::dialect::HiveDialect;
-use sqlparser::test_utils::*;
+use test_utils::*;
 
 #[test]
 fn parse_table_create() {

src/test_utils.rs renamed to tests/test_utils.rs

@@ -10,12 +10,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-/// This module contains internal utilities used for testing the library.
-/// While technically public, the library's users are not supposed to rely
-/// on this module, as it will change without notice.
-//
-// Integration tests (i.e. everything under `tests/`) import this
-// via `tests/test_utils/mod.rs`.
+#![allow(dead_code)]
 
 #[cfg(not(feature = "std"))]
 use alloc::{
@@ -26,10 +21,20 @@ use alloc::{
 };
 use core::fmt::Debug;
 
-use crate::ast::*;
-use crate::dialect::*;
-use crate::parser::{Parser, ParserError};
-use crate::tokenizer::Tokenizer;
+use sqlparser::ast::*;
+use sqlparser::dialect::*;
+use sqlparser::parser::{Parser, ParserError};
+use sqlparser::tokenizer::Tokenizer;
+
+#[macro_export]
+macro_rules! nest {
+    ($base:expr $(, $join:expr)*) => {
+        TableFactor::NestedJoin(Box::new(TableWithJoins {
+            relation: $base,
+            joins: vec![$(join($join)),*]
+        }))
+    };
+}
 
 /// Tests use the methods on this struct to invoke the parser on one or
 /// multiple dialects.