masking 1.1.1 → 1.1.2.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8229ba5463b487ff90ed68d770ce32e07d5d02859c12836eae99dc465ebe1378
-  data.tar.gz: 3b046df36bc1576e02412df76de34fa03c31583e4d8cc89c0c417dcbe86f09fd
+  metadata.gz: 8fff3fddd7077702babd4aeffafe86e80f79ab5151fb40ba92bba3ebf86513e3
+  data.tar.gz: f9f7d5ed2dbd5c1ebb6789d154c6c6fe64b72d4528ee923a6c4d0b8575e869ba
 SHA512:
-  metadata.gz: 3cd6d9271cbcdadc50281189db5e4ed73111996544d47ddb553b33e4d82a838d7dcc95b649ca6462cf9f1742256602feb22f973cba98adf5ebebb7b3fbb3ff79
-  data.tar.gz: f0dd87ee111bd69ef6586ce3aa18baf9b7734b8843c8d00b2480308244db7e98cb87f04f196ccd530d1690b0697f039dd7683ae60f147a8b66971ff762c0459e
+  metadata.gz: 909c267ad406fc1bded87cb368cd5b130612270e2a41046c129cc529f9dd3fbb29b1d799a71613e404333463c7af6f2a33f323b0e3a29af204aae0c48c96e54d
+  data.tar.gz: 618c7ff871b6ae32fc26095d0e409ffe67f1da6c4759a1a9ae45a93bc3336f1f775352a514d095955882c33bb874133df3d258af9c3040a4f6ed0d7bbf354789

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- adding dockerfile for github container images [#77](https://github.com/kibitan/masking/pull/77)
+- Update README.md about frequent asked question [#74](https://github.com/kibitan/masking/pull/74)
+
+### Fix
+
+- fix the error on the error message [#74](https://github.com/kibitan/masking/pull/74) relates issue  [#73](https://github.com/kibitan/masking/issues/73)
+
 ## [v1.1.1] - 2023-04-03
 
 ### Added

data/CODEOWNERS

@@ -0,0 +1 @@
+* @kibitan

data/Dockerfile

@@ -1,6 +1,6 @@
-ARG ruby_version=3.2
+ARG RUBY_VERSION=3.2
 
-FROM ruby:$ruby_version-alpine AS builder
+FROM ruby:${RUBY_VERSION}-alpine AS builder
 RUN apk add --no-cache build-base git
 RUN addgroup -S app && adduser -S -G app app
 USER app
@@ -13,7 +13,7 @@ USER root
 RUN apk add --no-cache mysql-client
 USER app
 
-FROM ruby:$ruby_version-alpine
+FROM ruby:${RUBY_VERSION}-alpine
 # TODO: remove dependecy of `git` from masking.gemspec:L19
 RUN apk add --no-cache git
 RUN addgroup -S app && adduser -S -G app app

data/Dockerfile.ghcr

@@ -0,0 +1,10 @@
+# `docker run ghcr.io/kibitan/masking`
+ARG RUBY_VERSION=3.2
+
+FROM ruby:$RUBY_VERSION-alpine
+RUN addgroup -S app && adduser -S -G app app
+USER app
+WORKDIR /app
+ARG MASKING_VERSION=1.1.1
+RUN gem install masking -v "${MASKING_VERSION}"
+ENTRYPOINT ["masking"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    masking (1.1.1)
+    masking (1.1.2.pre.alpha)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -29,33 +29,35 @@ gem install masking
 
 1. Setup configuration for anonymizing target tables/columns to `masking.yml`
 
+    *NOTE: the columns which doesn't mention here will be NOT anonymized, it stays as it is.*
+
     ```yaml
-      # table_name:
-      #   column_name: masked_value
-
-      users:
-        string: anonymized string
-        email: anonymized+%{n}@example.com # %{n} will be replaced with sequential number
-        integer: 12345
-        float: 123.45
-        boolean: true
-        null_column: null
-        date: 2018-08-24
-        time: 2018-08-24 15:54:06
-        binary_or_blob: !binary | # Binary Data Language-Independent Type for YAML™ Version 1.1: http://yaml.org/type/binary.html
-          R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5
-          OTk6enp56enmlpaWNjY6Ojo4SEhP/++f/++f/++f/++f/++f/++f/++f/++f/+
-          +f/++f/++f/++f/++f/++SH+Dk1hZGUgd2l0aCBHSU1QACwAAAAADAAMAAAFLC
-          AgjoEwnuNAFOhpEMTRiggcz4BNJHrv/zCFcLiwMWYNG84BwwEeECcgggoBADs=
-        # When a column name is suffixed with `?`, the original NULL value will not be anonymized.
-        # This option can be beneficial for simulating SQL execution that closely resembles the original data.
-        nullable_string?: anonymized nullable %{n} string
+    # table_name:
+    #   column_name: masked_value
+
+    users:
+      string: anonymized string
+      email: anonymized+%{n}@example.com # %{n} will be replaced with sequential number
+      integer: 12345
+      float: 123.45
+      boolean: true
+      null_column: null
+      date: 2018-08-24
+      time: 2018-08-24 15:54:06
+      binary_or_blob: !binary | # Binary Data Language-Independent Type for YAML™ Version 1.1: http://yaml.org/type/binary.html
+        R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5
+        OTk6enp56enmlpaWNjY6Ojo4SEhP/++f/++f/++f/++f/++f/++f/++f/++f/+
+        +f/++f/++f/++f/++f/++SH+Dk1hZGUgd2l0aCBHSU1QACwAAAAADAAMAAAFLC
+        AgjoEwnuNAFOhpEMTRiggcz4BNJHrv/zCFcLiwMWYNG84BwwEeECcgggoBADs=
+      # When a column name is suffixed with `?`, the original NULL value will not be anonymized.
+      # This option can be beneficial for simulating SQL execution that closely resembles the original data.
+      nullable_string?: anonymized nullable %{n} string
     ```
 
     A value will be implicitly converted to a compatible type. If you prefer to explicitly convert, you could use a tag as defined in [YAML Version 1.1](http://yaml.org/spec/current.html#id2503753)
 
     ```yaml
-      not-date: !!str 2002-04-28
+    not-date: !!str 2002-04-28
     ```
 
     String should be matched with [MySQL String Type]( https://dev.mysql.com/doc/refman/8.0/en/string-type-overview.html). Integer/Float should be matched with [MySQL Numeric Type](https://dev.mysql.com/doc/refman/8.0/en/numeric-type-overview.html). Date/Time should be matched with [MySQL Date and Time Type](https://dev.mysql.com/doc/refman/8.0/en/date-and-time-type-overview.html).

data/acceptance/expected_error_result.txt

@@ -0,0 +1,2 @@
+ERROR: config file (/app/acceptance/no_file.yml) does not exist
+ERROR: cannot parse SQL dump file. you may forget to put `--complete-insert` option in mysqldump?

data/acceptance/run_test.sh

@@ -10,16 +10,28 @@ MYSQL_DBNAME=${MYSQL_DBNAME:-mydb}
 
 FILEDIR="$( cd "$( dirname "$0" )" && pwd )"
 
-## clear tmp file
+# clear tmp file
 rm "$FILEDIR"/tmp/* || echo 'no tmp file'
 
-## import database
+# import database
 mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DBNAME" < "$FILEDIR/import_dumpfile.sql"
 
-## masking
+#  masking & restore
 mysqldump -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DBNAME" --complete-insert | exe/masking -c "$FILEDIR/masking.yml" > "$FILEDIR/tmp/masking_dumpfile.sql"
 mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DBNAME" < "$FILEDIR/tmp/masking_dumpfile.sql"
-
-## compare
+## compare the result
 mysql -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DBNAME" -e 'SELECT * FROM users ORDER BY id;' --vertical > "$FILEDIR/tmp/query_result.txt"
-diff "$FILEDIR/expected_query_result.txt" "$FILEDIR/tmp/query_result.txt"  && echo 'test passed!'
+diff "$FILEDIR/expected_query_result.txt" "$FILEDIR/tmp/query_result.txt" || (echo 'test failed' && exit 1)
+
+# test errors
+set +e
+## without masking.yml
+mysqldump -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DBNAME" --complete-insert | exe/masking -c "$FILEDIR/no_file.yml" 2>> "$FILEDIR/tmp/errors.txt" 1> /dev/null
+## without `--complete-insert``
+mysqldump -h "$MYSQL_HOST" -u "$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DBNAME" | exe/masking -c "$FILEDIR/masking.yml" 2>> "$FILEDIR/tmp/errors.txt" 1> /dev/null
+set -e
+### compare the result
+diff "$FILEDIR/expected_error_result.txt" "$FILEDIR/tmp/errors.txt" || (echo 'error output test failed' && exit 1)
+
+echo 'test passed!'
+exit 0

data/lib/masking/cli/error_message.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'pathname'
 require 'erb'
 require 'ostruct'
+require 'masking/errors'
 
 module Masking
   class Cli
@@ -19,19 +19,26 @@ module Masking
 
       attr_reader :error_class
 
-      YAML_FILE_PATH = Pathname('lib/masking/cli/error_messages.yml')
-
-      def error_messages
-        @error_messages = YAML.safe_load(YAML_FILE_PATH.read)
-      end
-
       def error_message(keyword_args)
         ERB.new(
-          error_messages.fetch(error_class.to_s)
+          ERROR_MESSAGES.fetch(error_class.to_s)
         ).result(
           OpenStruct.new(keyword_args).instance_eval { binding } # rubocop:disable Style/OpenStructUse
         )
       end
+
+      ERROR_MESSAGES = {
+        'Masking::Error::ConfigFileDoesNotExist' =>
+          'ERROR: config file (<%= config_file_path %>) does not exist',
+        'Masking::Error::ConfigFileIsNotFile' =>
+          'ERROR: config file (<%= config_file_path %>) is not file',
+        'Masking::Error::ConfigFileIsNotValidYaml' =>
+          'ERROR: config file (<%= config_file_path %>) is not valid yaml format',
+        'Masking::Error::ConfigFileContainsNullAsColumnName' =>
+          'ERROR: config file (<%= config_file_path %>) is not valid, column name contains `null`',
+        'Masking::Error::InsertStatementParseError' =>
+          'ERROR: cannot parse SQL dump file. you may forget to put `--complete-insert` option in mysqldump?'
+      }.freeze
     end
   end
 end

data/lib/masking/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Masking
-  VERSION = '1.1.1'
+  VERSION = '1.1.2-alpha'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: masking
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2.pre.alpha
 platform: ruby
 authors:
 - Chikahiro Tokoro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies: []
 description: Command line tool for anonymizing database records by parsing a SQL dump
   file and build new SQL dump file with masking sensitive/credential data.
@@ -31,13 +31,16 @@ files:
 - ".rubocop_todo.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Dockerfile
+- Dockerfile.ghcr
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- acceptance/expected_error_result.txt
 - acceptance/expected_query_result.txt
 - acceptance/import_dumpfile.sql
 - acceptance/masking.yml
@@ -76,7 +79,6 @@ files:
 - lib/masking.rb
 - lib/masking/cli.rb
 - lib/masking/cli/error_message.rb
-- lib/masking/cli/error_messages.yml
 - lib/masking/config.rb
 - lib/masking/config/target_columns.rb
 - lib/masking/config/target_columns/column.rb
@@ -120,9 +122,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.6
 signing_key:

data/lib/masking/cli/error_messages.yml

@@ -1,10 +0,0 @@
-Masking::Error::ConfigFileDoesNotExist:
-  "ERROR: config file (<%= config_file_path %>) does not exist"
-Masking::Error::ConfigFileIsNotFile:
-  "ERROR: config file (<%= config_file_path %>) is not file"
-Masking::Error::ConfigFileIsNotValidYaml:
-  "ERROR: config file (<%= config_file_path %>) is not valid yaml format"
-Masking::Error::ConfigFileContainsNullAsColumnName:
-  "ERROR: config file (<%= config_file_path %>) is not valid, column name contains `null`"
-Masking::Error::InsertStatementParseError:
-  "ERROR: cannot parse SQL dump file. you may forget to put `--complete-insert` option in mysqldump?"