safedb 0.7.1001 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32727ae3d52f041e5049daf92f2bb09aa5783b7d78e8f837f77025dae5a711d7
-  data.tar.gz: 8d26aad01a827d65f85d2445154e8ee38fbbbbce04570cbc51bd38c198c73c1d
+  metadata.gz: c5221d9e392de0ee7e1d506642281edbed9531f7b1cc8846f948c8186edeb1e3
+  data.tar.gz: 83805b1ef1d48f03171863ffb7ce6da789c4fadbda0946f5750ecf13a3de1417
 SHA512:
-  metadata.gz: a552f7d3b9b958cfad7910f777d1f3d1bd3c91b6bca0b0625c19ddee0699683650d3109fe82934860474035dd51b4333ff3e212442cf56b317f567813ea60dfc
-  data.tar.gz: 25cec4ed1f64dcd2d0faa8b6423601d867eebb4527202266d31bff7d77df57d77687284d51fefb4fb6ea6befb4aa7398ead2e9632fe2a0c0fcc265efc2546ceb
+  metadata.gz: 5601e437f9bcd5c05cf956b48ec453fbbccb144799e5cbfd2d89228aa0589cd16ac7ed345f8002f9887c37e05103e97e2e1d4d92675a4a5ced378612bcb254e5
+  data.tar.gz: ba1c693c125a8d625e9c0a7020583a7616fe8394e6ed72400af3b661d391f806a8db8695f4c69b2654cd2a74981fe8e57ea4702d09a047aaf374000f6dfa373c

data/CONTRIBUTING.md

@@ -3,8 +3,38 @@
 
 You can contriubute software, documentation, issues and even good ideas. Most contributions will either be integrations with other tools and technologies, or new use cases (plugins).
 
+**Ignore these instructions if you just want to use the software.** To **use the software** **[visit the readme](README.md)**.
 
-## Contributing Software
+
+---
+
+
+## Use Docker to Build and Run the Tests
+
+Using **`docker`** is the **simplest quickest** way to **build, package** and run the **cucumber/aruba** test suite.
+
+```
+# Get the safe software
+git clone https://github.com/devops4me/safedb.net.git
+cd safedb.net
+
+# Prepare the safe build docker image
+docker build --tag img.safeci .
+
+# Now run the safe build docker image
+docker run           \
+    --interactive    \
+    --tty            \
+    --rm             \
+    --name vm.safeci \
+    img.safeci
+```
+
+
+---
+
+
+## Building a Development Environment
 
 To contribute software you'll need to setup a development environment.
 
@@ -13,7 +43,7 @@ sudo apt install --assume-yes ruby-full libicu-dev git
 sudo chown -R $USER:$USER /var/lib/gems
 sudo chown -R $USER:$USER /usr/local/bin
 sudo chown -R $USER:$USER /usr/local/lib
-gem install safedb bundler gem-release cucumber aruba
+gem install bundler gem-release cucumber aruba
 git clone https://github.com/devops4me/safedb.net.git mirror.safedb.ro
 cd mirror.safedb
 rake install
@@ -24,6 +54,23 @@ cucumber
 You change the software as you see fit and **send a pull request** when you are ready.
 
 
+## Cucumber and Aruba | Installi the right version
+
+Aruba and Cucumber are **finickity** about both each others versions and the ruby version. If you see this output in the gem install command you need to act.
+
+```
+Fetching: aruba-0.14.12.gem (100%)
+Use on ruby 1.8.7
+* Make sure you add something like that to your `Gemfile`. Otherwise you will
+  get cucumber > 2 and this will fail on ruby 1.8.7
+
+  gem 'cucumber', '~> 1.3.20'
+
+With aruba >= 1.0 there will be breaking changes. Make sure to read https://github.com/cucumber/aruba/blob/master/History.md for 1.0.0
+Successfully installed aruba-0.14.12
+```
+
+
 ## Running Cucumber/Aruba Tests
 
 Use the simple **`cucumber`** command in the project directory to run the tests.
@@ -44,7 +91,7 @@ reek lib
 
 ## Automated Software Release
 
-safedb is automatically released by Jenkins using a GitOps style pipeline defined in the Jenkinsfile and Dockerfile. The release to rubygems.org depends on
+safedb is automatically released by Jenkins using a GitOps style pipeline defined in the **[Jenkinsfile]** and **[Dockerfile]**. The release to rubygems.org depends on
 
 - a pull request to the [safe github master branch](https://github.com/devops4me/safedb.net.git)
 - an error-free gem build

data/Dockerfile

@@ -0,0 +1,46 @@
+FROM ruby:latest
+
+# --->
+# ---> install the gems necessary to build test package and
+# ---> release this ruby project.
+# --->
+
+RUN gem install gem-release cucumber aruba yard reek
+
+
+# --->
+# ---> Create a non-root user from which cucumber and aruba
+# ---> orchestrate and validate command line behaviour.
+# --->
+
+RUN adduser --home /home/safeci --shell /bin/bash --gecos 'Safe TTY Test User' safeci && \
+  install -d -m 755 -o safeci -g safeci /home/safeci
+
+
+# --->
+# ---> Copy the project assets into the docker image.
+# --->
+
+COPY . /home/safeci/code/
+
+
+# --->
+# ---> Use rake to Copy the project assets into the docker image.
+# --->
+
+RUN chown -R safeci:safeci /home/safeci && \
+      chmod u+x /home/safeci/code/cucumber-test.sh && \
+        cd /home/safeci/code && \
+	  rake install
+
+
+# --->
+# ---> 
+# ---> As the safeci user employ cucumber and aruba to recursively
+# ---> find and execute all cucumber (*.feature) files under lib.
+# --->
+
+USER safeci
+WORKDIR /home/safeci/code
+
+####### ENTRYPOINT [ "/home/safeci/code/cucumber-test.sh" ]

data/Jenkinsfile

@@ -0,0 +1,45 @@
+pipeline
+{
+    agent none
+    stages
+    {
+        stage('Build Safe Docker Image')
+        {
+            agent
+            {
+                kubernetes
+                {
+                    defaultContainer 'kaniko'
+                    yamlFile 'pod-image-builder.yaml'
+                }
+            }
+            steps
+            {
+               /*
+                * We checkout the git repository again because we
+                * are running in a different pod setup specifically
+                * to build and test the software.
+                */
+                checkout scm
+                sh '/kaniko/executor -f `pwd`/Dockerfile -c `pwd` --destination devops4me/safetty:latest --cleanup'
+            }
+        }
+        stage('Run the Cucumber Tests')
+        {
+            agent
+            {
+                kubernetes
+                {
+                    yamlFile 'pod-image-safetty.yaml'
+                }
+            }
+            steps
+            {
+                container('safettytests')
+                {
+                    sh '/home/safeci/code/cucumber-test.sh'
+                }
+            }
+        }
+    }
+}

data/README.md

@@ -2,6 +2,22 @@ safe [![Build Status](https://secure.travis-ci.org/TwP/inifile.png)](http://trav
 ==========
 
 
+## safe drag `<<xxxx>>`
+
+if xxxx
+ - ends with a colon @--> book name
+ - begins with a colon and no slashes @--> chapter name
+ - has just one fwd slash @===> verse (could also have colon to specify different book or different chapter)
+ - has 2 fwd slashes ==> it is a line => may also have colon to specify different book or different chapter
+ - has no colon or fwd slashes its a line name
+
+With this notation the open chapter/verse does not change.
+Used in commands like safe delete | safe drag | safe drop | safe rename <<from>> <<to>>
+
+
+
+
+
 ## safe push | safe pull
 
 Working with <tt>remote (off-site) storage</tt> and <tt>sync-ing safe books</tt> between **different computers** is done using <tt>safe push</tt> and <tt>safe pull</tt>. Even with a single laptop you need a backup and restore process and this push pull is in-built and ready to go.

data/Rakefile

@@ -18,6 +18,6 @@ require 'yard'
 # This configuration allows us to run "rake yard"
 # to build documentation.
 YARD::Rake::YardocTask.new do |t|
- t.files   = ['lib/**/*.rb']   # optional
- t.stats_options = ['--list-undoc']
+    t.files   = ['lib/**/*.rb']   # optional
+    t.stats_options = ['--list-undoc']
 end

data/cucumber-test.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+## ####################################### ##
+## Exit this script when any command fails ##
+## ####################################### ##
+set -e
+
+# ++ +++ ++++++ # +++++ +++++++ # +++ +++++++++ # +++++++ # ++++ +++++ ++ #
+# ++ --- ------ # ----- ------- # --- --------- # ------- # ---- ----- ++ #
+# ++                                                                   ++ #
+# ++  Prepare for the cucumber orchestrated tests that are part of the ++ #
+# ++  build for the safedb personal database. This script exports the  ++ #
+# ++  protective safe token and then executes cucumber feature files.  ++ #
+# ++                                                                   ++ #
+# ++ --- ------ # ----- ------- # --- --------- # ------- # ---- ----- ++ #
+# ++ +++ ++++++ # +++++ +++++++ # +++ +++++++++ # +++++++ # ++++ +++++ ++ #
+
+echo "" ; echo "" ;
+echo "### ######################################## ###"
+echo "### Static Code Quality Analyzer Suggestions ###"
+echo "### ######################################## ###"
+echo ""
+
+reek lib
+echo ""
+
+echo "" ; echo "" ;
+echo "### ################################## ###"
+echo "### Ruby Execution Environment Details ###"
+echo "### ################################## ###"
+echo ""
+
+echo "Current directory is $(pwd)"
+echo "Current username is $(whoami)"
+echo "" ; ls -lh
+safe version
+
+echo ""
+echo "### ################################ ###"
+echo "### Exporting safe shell (tty) token ###"
+echo "### ################################ ###"
+echo ""
+
+export SAFE_TTY_TOKEN=$(safe token)
+
+echo "" ; echo "" ;
+echo "### ###################################### ###"
+echo "### Now executing the cucumber/aruba tests ###"
+echo "### ###################################### ###"
+echo ""
+
+cucumber lib
+echo ""
+
+exit 0

data/lib/cli.rb

@@ -360,7 +360,7 @@ class CLI < Thor
   # Creates remote storage for the safe database crypt files.
   def remote
     log.info(x) { "performing a remote storage use case. The provision flag is set to #{options[ :provision ]}." }
-    remote_uc = SafeDb::Remote.new()
+    remote_uc = SafeDb::RemoteGithubToken.new()
     remote_uc.provision = true if options[ :provision ]
     remote_uc.provision = false unless options[ :provision ]
     remote_uc.flow()
@@ -410,19 +410,32 @@ class CLI < Thor
 
 
   # Description of the safe database push command.
-  desc "push", "push crypts to github and put index keys on removable drive"
+  desc "push", "push commited safe crypts to the remote backend repository."
 
-  # After backing up local assets the <b>push use case</b> creates a remoe github
-  # repository if necessary and initializes the master crypts as a git repository
-  # if necessary and then adds, commits and pushes the crypts up to the github
-  # remote for safe keeping.
+  # This simple command does not require the user to be logged into a specific
+  # book. The only pre-condition is that safe remote --provision has been successfully
+  # run thus placing the required remote origin urls.
   def push
-    log.info(x) { "push crypt assets to github and refresh the index keys on removable drive." }
+    log.info(x) { "request to push safe crypts to the remote backend." }
     SafeDb::Push.new().flow()
   end
 
 
 
+
+  # Description of the safe database obliterate command.
+  desc "obliterate", "creates a backup then removes the entire safe master database"
+
+  # The obliterate command does not need to be secured behind authentication because
+  # all it does is delete a directory. Not withstanding taking a backup - this command
+  # is exactly like the bash rm -fr command.
+  def obliterate
+    log.info(x) { "request to obliterate the safedb master database." }
+    SafeDb::Obliterate.new().flow()
+  end
+
+
+
   # Description of the set configuration directives command.
   desc "set <directive_name> <directive_value>", "set book-scoped configuration directive"
 

data/lib/controller/abstract/controller.rb

@@ -35,12 +35,11 @@ module SafeDb
     def initialize
 
       class_name = self.class.name.split(":").last.downcase
-      is_no_token_uc = [ "token", "init", "id" ].include? class_name
+      is_no_token_uc = [ "token", "init", "id", "obliterate" ].include? class_name
       return if is_no_token_uc
       exit(100) unless ops_key_exists?
 
-      is_login_uc = [ "login", "push", "pull" ].include? class_name
-      return if is_login_uc
+      return if [ "login", "push", "pull" ].include? class_name
 
       not_logged_in = StateInspect.not_logged_in?()
       puts TextChunk.not_logged_in_message() if not_logged_in

data/lib/controller/access/init.rb

@@ -33,9 +33,6 @@ module SafeDb
 
     def execute
 
-# @todo => in parent class Authenticate validate the book name
-
-
       @book_id = Identifier.derive_ergonomic_identifier( @book_name, Indices::SAFE_BOOK_ID_LENGTH )
 
       if is_book_initialized?()
@@ -45,8 +42,6 @@ module SafeDb
 
       EvolveState.create_book( @book_id )
 
-# @todo => search for password in environment variable
-
       book_secret = KeyPass.password_from_shell( true ) if @password.nil?
       book_secret = @password unless @password.nil?
 
@@ -60,6 +55,15 @@ module SafeDb
         virginal_book()
       )
 
+      commit_msg = "safe init artifacts for newly created (#{@book_name}) book on #{TimeStamp.readable()}."
+
+      GitFlow.init( Indices::MASTER_CRYPTS_FOLDER_PATH )
+      GitFlow.config( Indices::MASTER_CRYPTS_FOLDER_PATH, "#{ENV[ "USER" ]}@#{Socket.gethostname()}", "SafeDb User" )
+      GitFlow.stage( Indices::MASTER_CRYPTS_FOLDER_PATH )
+      GitFlow.list( Indices::MASTER_CRYPTS_FOLDER_PATH )
+      GitFlow.list( Indices::MASTER_CRYPTS_FOLDER_PATH, true )
+      GitFlow.commit( Indices::MASTER_CRYPTS_FOLDER_PATH, commit_msg )
+
       print_success_initializing
 
     end
@@ -73,7 +77,7 @@ module SafeDb
       initial_db = DataStore.new()
       initial_db.store( Indices::SAFE_BOOK_INITIALIZE_TIME, TimeStamp.readable() )
       initial_db.store( Indices::SAFE_BOOK_NAME, @book_name )
-      initial_db.store( Indices::SAFE_BOOK_INIT_VERSION, Indices::SAFE_VERSION_STRING )
+      initial_db.store( Indices::SAFE_BOOK_INIT_VERSION, "#{Indices::SAFE_PRE_VERSION_STRING}#{SafeDb::VERSION}" )
       initial_db.store( Indices::SAFE_BOOK_CHAPTER_KEYS, {} )
 
       return initial_db.to_json
@@ -85,7 +89,7 @@ module SafeDb
 
       puts ""
       puts "You can go ahead and login."
-      puts "Your domain [#{@book_name}] is already setup."
+      puts "Your book [#{@book_name}] already exists."
       puts "You should already know the password."
       puts ""
       puts "    #{COMMANDMENT} login #{@book_name}"

data/lib/controller/access/login.rb

@@ -25,8 +25,6 @@ module SafeDb
   # - the shell's secure password reader
   class Login < Authenticate
 
-# DELETE ME #######################    attr_writer :clip, :login_book_id, :suppress_output
-
     # If the clip switch is present it signifies that the password should
     # be read in from the clipboard. Any text selection puts text into the
     # the clipboard - no need specifically to use Ctrl-c (copy).

data/lib/controller/book/commit.rb

@@ -33,6 +33,7 @@ module SafeDb
         puts "   safe refresh"
         puts "   safe commit"
         puts ""
+
         return
 
       end

data/lib/controller/db/obliterate.feature

@@ -0,0 +1,45 @@
+
+Feature: test safedb's obliterate command
+
+    This test will run the `safe obliterate` command
+
+    Scenario: checking the safe shell token exists
+        When I run `printenv`
+        Then the output should contain "SAFE_TTY_TOKEN"
+
+    Scenario: there is nothing to obliterate
+        When I run `safe obliterate`
+        Then the output should contain "There is nothing to obliterate"
+        And a directory named "~/.config/safedb/safedb-master-crypts" should not exist
+        And a directory named "~/.config/safedb/safedb-branch-crypts" should not exist
+        And a directory named "~/.config/safedb/safedb-branch-keys" should not exist
+
+    Scenario: initializing the safe to obliterate
+        When I run `safe init book1 --password=abc123XYZ`
+        Then the output should contain "Your book book1 with id r6h43w-c69155 is up"
+        And the output should contain "Success"
+        And a directory named "~/.config/safedb/safedb-master-crypts" should exist
+        And a file named "~/.config/safedb/safedb-master-crypts/safedb-master-keys.ini" should exist
+        And a directory named "~/.config/safedb/safedb-master-crypts/.git" should exist
+        And a directory named "~/.config/safedb/safedb-branch-crypts" should not exist
+        And a directory named "~/.config/safedb/safedb-branch-keys" should not exist
+
+    Scenario: logging into the (just initialized) safe
+        When I run `safe init book1 --password=abc123XYZ`
+        And I run `printenv`
+        And I run `safe login book1 --password=abc123XYZ`
+        Then the output should contain "SAFE_TTY_TOKEN"
+        And the output should contain "There are 0 chapters and 0 verses"
+        And a directory named "~/.config/safedb/safedb-master-crypts" should exist
+        And a file named "~/.config/safedb/safedb-master-crypts/safedb-master-keys.ini" should exist
+        And a directory named "~/.config/safedb/safedb-branch-crypts" should exist
+        And a directory named "~/.config/safedb/safedb-branch-keys" should exist
+
+    Scenario: now obliterating the safe we just created
+        When I run `safe init book1 --password=abc123XYZ`
+        And I run `safe login book1 --password=abc123XYZ`
+        And I run `safe obliterate`
+        Then the output should contain "The safe has been successfully obliterated"
+        And a directory named "~/.config/safedb/safedb-master-crypts" should not exist
+        And a directory named "~/.config/safedb/safedb-branch-crypts" should not exist
+        And a directory named "~/.config/safedb/safedb-branch-keys" should not exist

data/lib/controller/db/obliterate.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby
+	
+module SafeDb
+
+    # Obliterate the entire safe database by removing a number of folders. This is a
+    # drastic action especially as it will terminate all safe sessions on the machine
+    # no matter which shell is being used.
+    #
+    # This action is recoverable in two ways. The first is a "safe pull" if using a
+    # remote repository like git. The second is manual restoration of the obliterated
+    # folder which is saved in the safedb-backup-crypts folder.
+    class Obliterate < Controller
+
+        # Print message and return if the master crypts directory does not exist. Otherwise
+        # make a backup of the folder then obliterate
+        # - the master crypts folder
+        # - the branch crypts folder
+        # - the branch keys folder
+        def execute()
+
+            unless ( File.exist?( Indices::MASTER_CRYPTS_FOLDER_PATH ) && File.directory?( Indices::MASTER_CRYPTS_FOLDER_PATH ) )
+
+                puts ""
+                puts "  Could not find directory"
+                puts "  #{Indices::MASTER_CRYPTS_FOLDER_PATH}"
+                puts "  #{Indices::NOTHING_TO_OBLITERATE}"
+                puts ""
+                return
+
+            end
+
+            backup_folder_name = TimeStamp.yyjjj_hhmm_sst() + "-" + Indices::MASTER_CRYPTS_FOLDER_NAME
+            backup_folder_path = File.join( Indices::BACKUP_CRYPTS_FOLDER_PATH, backup_folder_name )
+            FileUtils.mkdir_p( backup_folder_path )
+            FileUtils.cp_r( "#{Indices::MASTER_CRYPTS_FOLDER_PATH}/.", backup_folder_path )
+
+            FileUtils.remove_dir( Indices::MASTER_CRYPTS_FOLDER_PATH ) if  ( File.exist?( Indices::MASTER_CRYPTS_FOLDER_PATH ) && File.directory?( Indices::MASTER_CRYPTS_FOLDER_PATH ) )
+            FileUtils.remove_dir( Indices::BRANCH_CRYPTS_FOLDER_PATH ) if  ( File.exist?( Indices::BRANCH_CRYPTS_FOLDER_PATH ) && File.directory?( Indices::BRANCH_CRYPTS_FOLDER_PATH ) )
+            FileUtils.remove_dir( Indices::BRANCH_INDICES_FOLDER_PATH ) if  ( File.exist?( Indices::BRANCH_INDICES_FOLDER_PATH ) && File.directory?( Indices::BRANCH_INDICES_FOLDER_PATH ) )
+
+            puts ""
+            puts "  The safe has been successfully obliterated."
+            puts "  The obliterated safe database is backed up in this folder."
+            puts "  #{backup_folder_path}"
+            puts "  safe init   # this will create a new safe"
+            puts "  safe pull   # downloads a remote safe db"
+            puts ""
+
+            return
+
+
+        end
+
+
+    end
+
+
+end

data/lib/controller/db/pull.rb

@@ -2,19 +2,19 @@
 	
 module SafeDb
 
-  # If the removable drive path is configured and exists and contains the master
-  # index file, the pull use case backs up both file and master crypts (if necessary)
-  # and then refreshes them with the state that exists in the remote mirrored git
-  # directory and the indices on the removable drive path.
-  class Pull < Controller
-
     # If the removable drive path is configured and exists and contains the master
     # index file, the pull use case backs up both file and master crypts (if necessary)
     # and then refreshes them with the state that exists in the remote mirrored git
     # directory and the indices on the removable drive path.
-    def execute()
+    class Pull < Controller
+
+        # If the removable drive path is configured and exists and contains the master
+        # index file, the pull use case backs up both file and master crypts (if necessary)
+        # and then refreshes them with the state that exists in the remote mirrored git
+        # directory and the indices on the removable drive path.
+        def execute()
 
-      puts ""
+            puts ""
 
       removable_drive_path = xxx # ~~~~ read this from the --to variable
       removable_drive_file = File.join( removable_drive_path, Indices::MASTER_INDICES_FILE_NAME )
@@ -41,29 +41,13 @@ module SafeDb
 
       is_git = File.exist?( Indices::MASTER_CRYPTS_GIT_PATH ) && File.directory?( Indices::MASTER_CRYPTS_GIT_PATH )
 
+            return
 
 
-=begin
-      require "octokit"
-############client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
-
-client = Octokit::Client.new(:access_token => '')
-user = client.user
-puts "Company Name => #{user[:company]}"
-puts "User Name => #{user[:name]}"
-puts "User ID => #{user[:id]}"
-puts "Email => #{user[:email]}"
-puts "Login => #{user[:login]}"
-puts "Biography => #{user[:bio]}"
-=end
-
-      return
+        end
 
 
     end
 
 
-  end
-
-
 end