Merge pull request #17 from PageUpPeopleOrg/mcd-module-test

ChintanRaval · web-flow · commit 6b16f4312a8d · 2019-03-04T13:10:48.000+11:00
Change MCD to proper module structure
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ A utility that persists state of a data pipeline execution and uses them to dete
 ## Usage
 
 ```
-$ python mcd.py [options] {db-connection-string} <command> [command-parameters]
+$ python -m mcd [options] {db-connection-string} <command> [command-parameters]
 ```
 
 - `options` include:
@@ -34,8 +34,8 @@ $ python mcd.py [options] {db-connection-string} <command> [command-parameters]
 To get help, use:
 
 ```
-$ python mcd.py --help
-$ python mcd.py <command> --help
+$ python -m mcd --help
+$ python -m mcd <command> --help
 ```
 
 ### Usage Example
@@ -44,18 +44,18 @@ $ python mcd.py <command> --help
 $ pipenv install
 $ pipenv shell
 
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname init-execution
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname init-execution
 
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname get-last-successful-execution
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname get-execution-last-updated-timestamp id-as-returned-by-get-last-successful-execution-command
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname get-last-successful-execution
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname get-execution-last-updated-timestamp id-as-returned-by-get-last-successful-execution-command
 
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname persist-models id-as-retured-by-init-command load ./relative/path/to/load/models **/*.json
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname compare-models id-as-retured-by-get-last-successful-execution-command id-as-retured-by-init-command load
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname persist-models id-as-retured-by-init-command load ./relative/path/to/load/models **/*.json
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname compare-models id-as-retured-by-get-last-successful-execution-command id-as-retured-by-init-command load
 
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname persist-models id-as-retured-by-init-command transform C:/absolute/path/to/transform/models group1/*.csv ./group2/**/*.sql
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname compare-models id-as-retured-by-get-last-successful-execution-command id-as-retured-by-init-command transform
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname persist-models id-as-retured-by-init-command transform C:/absolute/path/to/transform/models group1/*.csv ./group2/**/*.sql
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname compare-models id-as-retured-by-get-last-successful-execution-command id-as-retured-by-init-command transform
 
-$ python mcd.py postgresql+psycopg2://user:password@host:port/dbname complete-execution id-as-retured-by-init-command
+$ python -m mcd postgresql+psycopg2://user:password@host:port/dbname complete-execution id-as-retured-by-init-command
 ```
 
 ## Prerequisites
diff --git a/mcd.py b/mcd.py
diff --git a/mcd/BaseObject.py b/mcd/BaseObject.py
diff --git a/mcd/DataRepository.py b/mcd/DataRepository.py
@@ -1,11 +1,11 @@
 from sqlalchemy import desc, select
 from sqlalchemy.sql import func
 from sqlalchemy.orm import sessionmaker
-from modules import Shared
-from modules.BaseObject import BaseObject
-from modules.Shared import Constants
-from modules.entities.DataPipelineExecutionEntity import DataPipelineExecutionEntity
-from modules.entities.ModelChecksumEntity import ModelChecksumEntity
+from mcd import Shared
+from mcd.BaseObject import BaseObject
+from mcd.Shared import Constants
+from mcd.entities.DataPipelineExecutionEntity import DataPipelineExecutionEntity
+from mcd.entities.ModelChecksumEntity import ModelChecksumEntity
 
 
 class DataRepository(BaseObject):
diff --git a/mcd/ModelChangeDetector.py b/mcd/ModelChangeDetector.py
@@ -1,15 +1,15 @@
 import argparse
 import logging
 
-from modules import Shared
-from modules.BaseObject import BaseObject
-from modules.Shared import Constants
-from modules.commands.InitialiseExecutionCommand import InitialiseExecutionCommand
-from modules.commands.GetLastSuccessfulExecutionCommand import GetLastSuccessfulExecutionCommand
-from modules.commands.GetExecutionLastUpdateTimestampCommand import GetExecutionLastUpdateTimestampCommand
-from modules.commands.PersistModelsCommand import PersistModelsCommand
-from modules.commands.CompareModelsCommand import CompareModelsCommand
-from modules.commands.CompleteExecutionCommand import CompleteExecutionCommand
+from mcd import Shared
+from mcd.BaseObject import BaseObject
+from mcd.Shared import Constants
+from mcd.commands.InitialiseExecutionCommand import InitialiseExecutionCommand
+from mcd.commands.GetLastSuccessfulExecutionCommand import GetLastSuccessfulExecutionCommand
+from mcd.commands.GetExecutionLastUpdateTimestampCommand import GetExecutionLastUpdateTimestampCommand
+from mcd.commands.PersistModelsCommand import PersistModelsCommand
+from mcd.commands.CompareModelsCommand import CompareModelsCommand
+from mcd.commands.CompleteExecutionCommand import CompleteExecutionCommand
 
 
 class ModelChangeDetector(BaseObject):
diff --git a/mcd/Shared.py b/mcd/Shared.py
diff --git a/mcd/__init__.py b/mcd/__init__.py
diff --git a/mcd/__main__.py b/mcd/__main__.py
@@ -0,0 +1,3 @@
+from mcd.ModelChangeDetector import ModelChangeDetector
+
+ModelChangeDetector()
diff --git a/mcd/commands/BaseCommand.py b/mcd/commands/BaseCommand.py
@@ -1,6 +1,6 @@
 from sqlalchemy import create_engine
-from modules.DataRepository import DataRepository
-from modules.BaseObject import BaseObject
+from mcd.DataRepository import DataRepository
+from mcd.BaseObject import BaseObject
 
 
 class BaseCommand(BaseObject):
diff --git a/mcd/commands/CompareModelsCommand.py b/mcd/commands/CompareModelsCommand.py
@@ -1,5 +1,5 @@
-from modules.commands.BaseCommand import BaseCommand
-from modules.Shared import Constants
+from mcd.commands.BaseCommand import BaseCommand
+from mcd.Shared import Constants
 
 
 class CompareModelsCommand(BaseCommand):
diff --git a/mcd/commands/CompleteExecutionCommand.py b/mcd/commands/CompleteExecutionCommand.py
@@ -1,6 +1,6 @@
 import hashlib
 from pathlib import Path
-from modules.commands.BaseCommand import BaseCommand
+from mcd.commands.BaseCommand import BaseCommand
 
 
 class CompleteExecutionCommand(BaseCommand):
diff --git a/mcd/commands/GetExecutionLastUpdateTimestampCommand.py b/mcd/commands/GetExecutionLastUpdateTimestampCommand.py
@@ -1,5 +1,5 @@
-from modules.commands.BaseCommand import BaseCommand
-from modules.Shared import Constants
+from mcd.commands.BaseCommand import BaseCommand
+from mcd.Shared import Constants
 
 
 class GetExecutionLastUpdateTimestampCommand(BaseCommand):
diff --git a/mcd/commands/GetLastSuccessfulExecutionCommand.py b/mcd/commands/GetLastSuccessfulExecutionCommand.py
@@ -1,5 +1,5 @@
-from modules.commands.BaseCommand import BaseCommand
-from modules.Shared import Constants
+from mcd.commands.BaseCommand import BaseCommand
+from mcd.Shared import Constants
 
 
 class GetLastSuccessfulExecutionCommand(BaseCommand):
diff --git a/mcd/commands/InitialiseExecutionCommand.py b/mcd/commands/InitialiseExecutionCommand.py
@@ -1,4 +1,4 @@
-from modules.commands.BaseCommand import BaseCommand
+from mcd.commands.BaseCommand import BaseCommand
 
 
 class InitialiseExecutionCommand(BaseCommand):
diff --git a/mcd/commands/PersistModelsCommand.py b/mcd/commands/PersistModelsCommand.py
@@ -1,6 +1,6 @@
 import hashlib
 from pathlib import Path
-from modules.commands.BaseCommand import BaseCommand
+from mcd.commands.BaseCommand import BaseCommand
 
 
 class PersistModelsCommand(BaseCommand):
diff --git a/mcd/commands/__init__.py b/mcd/commands/__init__.py
diff --git a/mcd/entities/DataPipelineExecutionEntity.py b/mcd/entities/DataPipelineExecutionEntity.py
@@ -2,8 +2,8 @@
 from sqlalchemy.sql import func
 from sqlalchemy.dialects.postgresql import UUID
 import uuid
-from modules.Shared import Constants
-from modules import Shared
+from mcd.Shared import Constants
+from mcd import Shared
 
 TABLE_NAME = 'data_pipeline_execution'
 PRIMARY_KEY_COL_NAME = 'id'
diff --git a/mcd/entities/ModelChecksumEntity.py b/mcd/entities/ModelChecksumEntity.py
@@ -1,9 +1,9 @@
 from sqlalchemy import Column, DateTime, Integer, String, ForeignKey
 from sqlalchemy.sql import func
 from sqlalchemy.dialects.postgresql import UUID
-from modules import Shared
-from modules.Shared import Constants
-from modules.entities import DataPipelineExecutionEntity
+from mcd import Shared
+from mcd.Shared import Constants
+from mcd.entities import DataPipelineExecutionEntity
 
 TABLE_NAME = 'model_checksum'
 
diff --git a/mcd/entities/__init__.py b/mcd/entities/__init__.py
diff --git a/tests/integration/test_integration.sh b/tests/integration/test_integration.sh
@@ -6,7 +6,7 @@ set -e
 # Bootstrap
 ## Aliases
 loadModelDirectory="./tests/integration/models/load"
-mcd="pipenv run python mcd.py postgresql+psycopg2://postgres:travisci@localhost:5432/postgres"
+mcd="pipenv run python -m mcd postgresql+psycopg2://postgres:travisci@localhost:5432/postgres"
 
 InitExecution () {
     executionId=$($mcd init-execution)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from mcd.ModelChangeDetector import ModelChangeDetector`
	`2`	`+`
	`3`	`+ModelChangeDetector()`