feat: Add --version and --create-config options (#41)

Author: aquamatthias

cloud2sql/__main__.py

@@ -1,12 +1,15 @@
 from logging import getLogger
 from typing import Optional
+
+import yaml
 from resotolib.args import Namespace, ArgumentParser
 from resotolib.logger import setup_logger
 from sqlalchemy import create_engine
 from sqlalchemy.engine import Engine
 
+from cloud2sql import __version__
 from cloud2sql.analytics import PosthogEventSender, NoEventSender, AnalyticsEventSender
-from cloud2sql.collect_plugins import collect_from_plugins, configure
+from cloud2sql.collect_plugins import collect_from_plugins, configure, default_config
 from cloud2sql.util import db_string_from_config, check_parquet_driver
 
 # Will fail in case snowflake is not installed - which is fine.
@@ -21,11 +24,11 @@
 def parse_args() -> Namespace:
     parser = ArgumentParser(
         description="Collect data from cloud providers and store it in a database",
-        epilog="Synchronizes cloud data to a database",
+        epilog="Synchronizes cloud data to a database. Visit https://cloud2sql.com for more information.",
         env_args_prefix="CLOUD2SQL_",
     )
     parser.add_argument("--debug", action="store_true", help="Enable debug logging")
-    parser.add_argument("--config", help="Path to config file", required=True)
+    parser.add_argument("--config", help="Path to config file")
     parser.add_argument(
         "--show",
         choices=["progress", "log", "none"],
@@ -36,9 +39,29 @@ def parse_args() -> Namespace:
         "--analytics-opt-out",
         default=False,
         action="store_true",
-        help="Do not send anonimized analytics data",
+        help="Do not send anonymized analytics data",
+    )
+    parser.add_argument(
+        "--version",
+        default=False,
+        action="store_true",
+        help="Print version and exit",
+    )
+    parser.add_argument(
+        "--create-config",
+        action="store_true",
+        help="Print empty configuration and exit. Use this to create your own config file.",
     )
     args = parser.parse_args()
+    if args.version:
+        print(f"Cloud2SQL Version {__version__}")
+        exit(0)
+    elif args.create_config:
+        cfg = {"sources": default_config(), "destinations": {"sqlite": {"database": "cloud2sql.db"}}}
+        print(yaml.safe_dump(cfg, sort_keys=False))
+        exit(0)
+    elif not args.config:
+        parser.error("The following arguments are required: --config")
     args.log_level = "CRITICAL" if args.show != "log" else "DEBUG" if args.debug else "INFO"
     return args  # type: ignore
 
@@ -59,7 +82,7 @@ def main() -> None:
         sender = NoEventSender() if args.analytics_opt_out else PosthogEventSender()
         config = configure(args.config)
         engine = None
-        if config["destinations"].keys() & set(["file", "s3", "gcs"]):
+        if config["destinations"].keys() & {"file", "s3", "gcs"}:
             check_parquet_driver()
         else:
             engine = create_engine(db_string_from_config(config))

cloud2sql/collect_plugins.py

@@ -20,7 +20,7 @@
 from resotolib.config import Config
 from resotolib.core.actions import CoreFeedback
 from resotolib.core.model_export import node_to_dict
-from resotolib.json import from_json
+from resotolib.json import from_json, to_json
 from resotolib.proc import emergency_shutdown
 from resotolib.types import Json
 from rich import print as rich_print
@@ -45,6 +45,17 @@
 log = getLogger("resoto.cloud2sql")
 
 
+def default_config() -> Json:
+    config: Config = Config  # type: ignore
+    for entry_point in pkg_resources.iter_entry_points("resoto.plugins"):
+        plugin_class = entry_point.load()
+        if issubclass(plugin_class, BaseCollectorPlugin):
+            plugin_class.add_config(config)
+
+    Config.init_default_config()
+    return to_json(Config.running_config.data)
+
+
 def collectors(raw_config: Json, feedback: CoreFeedback) -> Dict[str, BaseCollectorPlugin]:
     result = {}
     config: Config = Config  # type: ignore
@@ -149,7 +160,7 @@ def collect(
     if engine:
         return collect_sql(collector, engine, feedback, args)
     else:
-        if not set(["file", "s3", "gcs"]) & config["destinations"].keys():
+        if not {"file", "s3", "gcs"} & config["destinations"].keys():
             raise ValueError("No file destination configured")
         return collect_to_file(collector, feedback, config["destinations"]["arrow"])