datamaskin / dectool Goto Github PK

#DecTool (decrypt tool)

##Usage Help

• Type at the command line prompt: java -jar dectool-0.1.jar with no command line arguments (help message is displayed)
• The command line args are in alphabetical order and currently working to reorder the argument list.
• The defaults (and required values) are:
  • Both to and from DB names
  • Both to and from environments
  • Path to dectoolargs file (see example below)
  • Transaction count before commit
  • Fetch first size
  • A where clause that will constrain the rows
• The outcome: the returned data column is decrypted and written to the to_db along with the remaining column data.

###The where clause This tool is designed only to accept the where clause as a positional parameter. This means there is no named option for the where clause as is the case with the db name, environment and ora_messenger.xml location. The where clause must have a leading double dash (--) without parentheses to signal the end of named options. The tool assumes and consumes everything after the double dash as where clause. Example command line: java -jar dectool-1.0.jar -e TEST -f MVR -t MVR_IN -E TEST -s 400 -c 5 -- req.state='MS' and req.product_code!='31'

####Git clone and build Use git bash here in Explorer ostensibly right clicking your favorite directory. Run: git clone ssh://git.iix.com/git/Common/dectool.git

To build the tool with the tests cases a copy of ora_messenger.xml must be accessible to the toolkit with the following snippet:

<TEST>
        <TnsName>oratestm.world</TnsName>
        <Schema>MVR</Schema>
        <User></User>
        <Pswd></Pswd>
        <EncpPswd></EncpPswd>
        <JavaURL>jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=DEVTIP)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=oratestM.world)))</JavaURL>
</TEST>

It is recommended that if the end user does not wish to do further development then the tool should be built without the test cases. To build without test cases the mvnw cmd should be:

• ./mvnw -DskipTests=true clean compile package (Linux)
• mvnw -DskipTests=true clean compile package (Windows)
• JDK: 1.8

#####Running dectool

• The correct version of TrimConfig.properties for the target user must be placed in the resources directory to enable decryption.
• To use a CLI input file please see the dectool args template at: src/main/resources/dectoolargs.template
• Assuming the minimal requirements the user should be able to execute the following:

java -jar -Dlogback.configurationFile=c:\utils\logback.xml target/dectool-0.1.jar @src/main/resources/dectoolargs

• Use the dectoolargs.template as just that: a template.
• Name the file to reflect the where clause or dbname and environment used.
• There is a reference in the template file and repeated here for instructions on how to construct an input file. https://picocli.info/#AtFiles

######logback.xml

<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
    <logger name="iix.util.DecToolCommand" level="INFO" />
</configuration>

######Tool creation and config Assuming sdkman is installed:

• JDK 1.8+ installed
• Micronaut installed 1.0.0
• At the CLI run:

mn create-cli-app --build maven --test spock dectool

######dectool args file template

# DecTool args file template
# This file is only a go-by as an example of how to run dectool CLI args from a file
# This file resides in resources but can but put anywhere as long as the correct path is specified on the command-line
# e.g. @src/main/resources/dectoolargs
# Reference: https://picocli.info/#AtFiles
# The example CLI below has been commented out not reccommended to use this file.
#-e
#TEST
#-f
#MVR
#-t
#MVR_IN
#-E
#TEST
#-s
#400
#-c
#20
#--
#"req.state='MS'"
#and
#"req.product_code!='31'"

######Running the tests

• If not already clone repo: ssh://git.iix.com:/git/Common/TrimConfigProperties.git
• At the commandline define envvar: TRIM_CONFIG_PATH
• Linux: export TRIM_CONFIG_PATH=
• ./mvnw clean compile package
• Windows: set TRIM_CONFIG_PATH=
• mvnw clean compile package
• Outcome all tests pass: Build Success
• 1 test fails such as decryption:

Test set: iix.util.DecToolCommandTest
-------------------------------------------------------------------------------
Tests run: 4, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 6.788 s <<< FAILURE! - in iix.util.DecToolCommandTest
Test where clauses to be put on the DecTool CLI to fetch the request_id(s) of the encrypted data, decrypt and insert into enh(iix.util.DecToolCommandTest)  Time elapsed: 3.264 s  <<< FAILURE!
org.spockframework.runtime.ConditionNotSatisfiedError: 
Condition not satisfied:

!wrongdelimiter
||
|true
false

	at iix.util.DecToolCommandTest.Test where clauses to be put on the DecTool CLI to fetch the request_id(s) of the encrypted data, decrypt and insert into enh(DecToolCommandTest.groovy:227)