revenc 0.1.2

data/features/app.feature

@@ -0,0 +1,59 @@
+@announce
+Feature: Application actions, configuration and error handling
+
+  As an interactive user or automated script
+  The application should accept actions and report errors 
+
+  Scenario: No command line action
+    When I run "revenc"
+    Then the exit status should be 1
+    And I should see matching: 
+      """
+      ^.* action required
+      ^.* --help for more information
+      """
+
+  Scenario: Invalid action
+    When I run "revenc non-existing-action"
+    Then the exit status should be 1
+    And I should see matching: 
+      """
+      ^.* invalid action: non-existing-action
+      ^.* --help for more information
+
+      """
+
+  Scenario: --config FILE (exists)
+    Given an empty file named "config.conf"
+    When I run "revenc mount --verbose --config config.conf"
+    Then I should see: 
+      """
+      loading config file: config.conf
+      """
+
+  Scenario: --config FILE (not found)
+    When I run "revenc mount --verbose --config config.conf"
+    Then I should not see: 
+      """
+      loading config file: config.conf
+      """
+    And I should see: 
+      """
+      config file not found 
+      """
+
+  Scenario: Backtrace with --verbose option
+    When I run "revenc --verbose mount bad_source bad_dest"
+    Then the exit status should be 1
+    And I should see matching: 
+      """
+      lib/(.*)/app.rb
+      """
+
+  Scenario: No backtrace without --verbose option
+    When I run "revenc mount bad_source bad_dest --no-verbose"
+    Then the exit status should be 1
+    And I should not see: 
+      """
+      /app.rb:
+      """

data/features/bin.feature

@@ -0,0 +1,35 @@
+@announce
+Feature: Options via a command line interface (CLI)
+
+  As an interactive user or automated script
+  The application should accept options on the command line
+  These options should override hard coded defaults 
+  In order to configure options
+
+  Scenario: Version info
+    When I run "revenc --version"
+    Then the exit status should be 0
+    And I should see matching "revenc, version ([\d]+\.[\d]+\.[\d]+$)"
+
+  Scenario: Help
+    When I run "revenc --help"
+    Then the exit status should be 0
+    And I should see matching: 
+      """
+      .*
+        Usage: .*
+      .*
+      Options:
+      .*
+          -v, --\[no-\]verbose               Run verbosely
+      """
+
+  Scenario: Invalid option
+    When I run "revenc --non-existing-option"
+    Then the exit status should be 1
+    And I should see matching: 
+      """
+      ^.* invalid option: --non-existing-option
+      ^.* --help for more information
+
+      """

data/features/configuration.feature

@@ -0,0 +1,98 @@
+@announce
+Feature: Configuration via yaml file
+
+  In order to configure options
+  As an interactive user or automated script
+  The program should process configuration options via yaml
+  These options should override hard coded defaults but not command line options
+
+  Background: A valid config file
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        source:
+          name: source_folder_name
+        mountpoint:
+          name: destination_folder_name
+        passphrasefile:
+          name: testme1.conf
+        keyfile:
+          name: encfs6.xml
+        executable: echo
+        cmd: cat <%%= passphrasefile.name %> | ENCFS6_CONFIG=<%%= keyfile.name %> <%%= executable %> --stdinpass --reverse <%%= source.name %> <%%= mountpoint.name %> -- -o ro
+      unmount:
+        mountpoint:
+          name: defaults_to_mount_mountpoint
+        executable: echo
+        cmd: <%%= executable %> -u <%%= name %>
+      copy:
+        source:
+          name: copy_source_defaults_to_mount_mountpoint
+        destination:
+          name: copy_to_destination
+        executable: echo
+        cmd: <%%= executable %> -e ssh --bwlimit=16 --perms --links --times --recursive --verbose --compress --stats --human-readable --inplace <%%= source.name %> <%%= destination.name %>
+      """
+
+  Scenario: Mount with a config file
+    When I run "revenc --verbose --dry-run mount"
+    Then I should see:
+      """
+      mount: source=source_folder_name
+      mount: mountpoint=destination_folder_name
+      mount: passphrasefile=testme1.conf
+      mount: keyfile=encfs6.xml
+      mount: cmd=cat testme1.conf | ENCFS6_CONFIG=encfs6.xml /bin/echo --stdinpass --reverse source_folder_name destination_folder_name -- -o ro
+      mount: executable=/bin/echo
+      """
+
+  Scenario: Unmount with a config file
+    When I run "revenc unmount --verbose --dry-run"
+    Then I should see:
+      """
+      unmount: mountpoint=defaults_to_mount_mountpoint
+      unmount: cmd=/bin/echo -u defaults_to_mount_mountpoint
+      unmount: executable=/bin/echo
+      """
+
+  Scenario: Unmount with a config file missing unmount.mountpoint 
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: unmount_mountpoint_defaults_to_me
+      """
+    When I run "revenc unmount --verbose --dry-run"
+    Then I should see:
+      """
+      unmount: mountpoint=unmount_mountpoint_defaults_to_me
+      """
+
+  Scenario: Copy with a config file
+    When I run "revenc copy --verbose --dry-run"
+    Then I should see:
+      """
+      copy: source=copy_source_defaults_to_mount_mountpoint
+      copy: destination=copy_to_destination
+      copy: cmd=/bin/echo -e ssh --bwlimit=16 --perms --links --times --recursive --verbose --compress --stats --human-readable --inplace copy_source_defaults_to_mount_mountpoint copy_to_destination
+      copy: executable=/bin/echo
+      """
+
+  Scenario: Copy with a config file missing source
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: copy_source_defaults_to_me
+      copy:
+        destination:
+          name: copy_to_destination
+      """
+    When I run "revenc copy --verbose --dry-run"
+    Then I should see:
+      """
+      copy: source=copy_source_defaults_to_me
+      copy: destination=copy_to_destination
+      """
+
+  Scenario: Config file specified via the command line

data/features/copy.feature

@@ -0,0 +1,169 @@
+@announce
+Feature: Copy encrypted data to another location via rsync
+
+  As an interactive user or automated script
+  The program should copy the encrypted data to another location
+  And lock the process to prevent automated recursion on long running copy commands
+  In order to backup the data and allow recovery of the unencrypted data
+
+  Scenario: Sucessful copy
+    Given a directory named "encrypted_source_folder"
+    Given a directory named "encrypted_destination"
+    Given an empty file named "encrypted_source_folder/test_data1.txt"
+    Given an empty file named "encrypted_source_folder/test_data2.txt"
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: encrypted_source_folder
+      """
+    When I run "revenc copy encrypted_source_folder encrypted_destination"
+    Then the exit status should be 0
+    And the following files should exist:
+      | encrypted_destination/encrypted_source_folder/test_data1.txt |
+      | encrypted_destination/encrypted_source_folder/test_data2.txt |
+
+  Scenario: Sucessful copy dry run
+    Given a directory named "encrypted_source_folder"
+    Given a directory named "encrypted_destination"
+    Given an empty file named "encrypted_source_folder/test_data1.txt"
+    Given an empty file named "encrypted_source_folder/test_data2.txt"
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: encrypted_source_folder
+      """
+    When I run "revenc copy --dry-run encrypted_source_folder encrypted_destination"
+    Then the exit status should be 0
+    And the following files should not exist:
+      | encrypted_destination/encrypted_source_folder/test_data1.txt |
+      | encrypted_destination/encrypted_source_folder/test_data2.txt |
+
+  Scenario: Copy already running (mutex/lock file check)
+    Given a directory named "encrypted_source_folder"
+    Given a directory named "encrypted_destination"
+    Given an empty file named "encrypted_source_folder/test_data.txt"
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: encrypted_source_folder
+      """
+    When I run with a lock file present "revenc copy encrypted_source_folder encrypted_destination"
+    Then the exit status should be 1
+    And I should see:
+      """
+      action failed, lock file present
+      """
+
+  Scenario: Source folder not specified
+    When I run "revenc copy"
+    Then the exit status should be 1
+    And I should see:
+      """
+      source folder not specified
+      """
+
+  Scenario: Destination not specified
+    When I run "revenc copy encrypted_source_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      destination not specified
+      """
+
+  Scenario: Source folder doesn't exist
+    When I run "revenc copy encrypted_source_folder encrypted_destination"
+    Then the exit status should be 1
+    And I should see:
+      """
+      source folder not found
+      """
+
+  Scenario: Source folder is empty
+    Given a directory named "encrypted_source_folder"
+    When I run "revenc copy encrypted_source_folder encrypted_destination"
+    Then the exit status should be 1
+    And I should see:
+      """
+      source folder is empty
+      """
+
+  Scenario: Source folder contains files but mount point empty (not mounted)
+    Given a directory named "copy_to_destination"
+    Given a directory named "parent_folder"
+    Given a directory named "parent_folder/encrypted_data_mountpoint"
+    Given a directory named "parent_folder/plain_text_key_here"
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: parent_folder/encrypted_data_mountpoint
+      copy:
+        source:
+          name: parent_folder
+        destination:
+          name: copy_to_destination
+      """
+    When I run "revenc copy --verbose --dry-run"
+    Then I should see:
+      """
+      mountpoint is empty
+      """
+
+  Scenario: Source folder contains files, mountpoint does not exist
+    Given a directory named "copy_to_destination"
+    Given a directory named "parent_folder"
+    Given a directory named "parent_folder/plain_text_key_here"
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        mountpoint:
+          name: parent_folder/encrypted_data_mountpoint
+      copy:
+        source:
+          name: parent_folder
+        destination:
+          name: copy_to_destination
+      """
+    When I run "revenc copy --verbose --dry-run"
+    Then I should see:
+      """
+      mountpoint not found
+      """
+
+  Scenario: Source folder contains files, mountpoint not specified
+    Given a directory named "copy_to_destination"
+    Given a directory named "parent_folder"
+    Given a directory named "parent_folder/plain_text_key_here"
+    Given a file named "revenc.conf" with:
+      """
+      copy:
+        source:
+          name: parent_folder
+        destination:
+          name: copy_to_destination
+      """
+    When I run "revenc copy --verbose --dry-run"
+    Then I should not see:
+      """
+      mountpoint not found
+      """
+    And I should not see:
+      """
+      mountpoint is empty
+      """
+
+  Scenario: Missing executable
+    Given a file named "revenc.conf" with:
+      """
+      copy:
+        executable: missing_bin_file
+      """
+    When I run "revenc copy encrypted_source_folder encrypted_destination"
+    Then the exit status should be 1
+    And I should see:
+      """
+      executable not found
+      """

data/features/generator.feature

@@ -0,0 +1,15 @@
+@announce
+Feature: Generate config files
+
+  As the user setting up revenc
+  The program should generate a config file
+  To save the hassle of manual config file creation
+  And provide reasonable starting default values
+
+  Scenario: Sucessful generate
+
+  Scenario: Config file already exists
+
+  Scenario: Source not given
+
+  Scenario: Mountpoint not given

data/features/mount.feature

@@ -0,0 +1,133 @@
+@announce
+Feature: Reverse mount encrypted folder using encfs
+
+  As a user with unencrypted data 
+  I need to mount an encrypted folder from an unencrypted folder
+  In order to backup the encrypted folder to untrusted systems 
+
+  @unmount_after
+  Scenario: Successful mount
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    Given a directory named "encrypted_destination_folder"
+    Given a valid encfs keyfile named "encfs6.xml"
+    Given a file named "passphrase" with:
+      """
+      test
+      """
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then I should not see "For more information, see the man page encfs(1)"
+    And the exit status should be 0
+
+  Scenario: Successful mount dry run
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    Given a directory named "encrypted_destination_folder"
+    Given a valid encfs keyfile named "encfs6.xml"
+    Given a file named "passphrase" with:
+      """
+      test
+      """
+    When I run "revenc --dry-run mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 0
+    And the folder "encrypted_destination_folder" should not be mounted
+
+  Scenario: Source folder not specified
+    When I run "revenc mount"
+    Then the exit status should be 1
+    And I should see:
+      """
+      source folder not specified
+      """
+
+  Scenario: Destination mount point not specified
+    When I run "revenc mount unencrypted_source_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      mountpoint not specified
+      """
+
+  Scenario: Source folder doesn't exist
+    Given a directory named "encrypted_destination_folder"
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      source folder not found
+      """
+
+  Scenario: Destination mount point doesn't exist
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      mount point not found
+      """
+
+  Scenario: Destination mount point is not empty
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    Given a directory named "encrypted_destination_folder"
+    Given an empty file named "encrypted_destination_folder/should_not_be_here.txt"
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      mount point is not empty
+      """
+
+  Scenario: Passphrase file not found
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    Given a directory named "encrypted_destination_folder"
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      mount point passphrase file not found
+      """
+
+  Scenario: Passphrase file is empty
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    Given a directory named "encrypted_destination_folder"
+    Given an empty file named "passphrase"
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      mount point passphrase file is empty
+      """
+
+  Scenario: Key file not found
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      key file not found
+      """
+
+  Scenario: Key file is empty
+    Given an empty file named "encfs6.xml"
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      key file is empty
+      """
+
+  Scenario: Missing executable
+    Given a file named "revenc.conf" with:
+      """
+      mount:
+        executable: missing_bin_file
+      """
+    When I run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      executable not found
+      """

data/features/step_definitions/revenc_steps.rb

@@ -0,0 +1,64 @@
+require 'revenc/io'
+
+Given /^a valid encfs keyfile named "([^\"]*)"$/ do |filename|
+  steps %Q{
+    Given a file named "#{filename}" with:
+      """
+      <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+      <!DOCTYPE boost_serialization>
+      <boost_serialization signature="serialization::archive" version="4">
+      <config class_id="0" tracking_level="1" version="20080816" object_id="_0">
+              <creator>EncFS 1.5</creator>
+              <cipherAlg class_id="1" tracking_level="0" version="0">
+                      <name>ssl/aes</name>
+                      <major>2</major>
+                      <minor>2</minor>
+              </cipherAlg>
+              <nameAlg>
+                      <name>nameio/null</name>
+                      <major>1</major>
+                      <minor>0</minor>
+              </nameAlg>
+              <keySize>128</keySize>
+              <blockSize>1024</blockSize>
+              <uniqueIV>0</uniqueIV>
+              <chainedNameIV>0</chainedNameIV>
+              <externalIVChaining>0</externalIVChaining>
+              <blockMACBytes>0</blockMACBytes>
+              <blockMACRandBytes>0</blockMACRandBytes>
+              <allowHoles>1</allowHoles>
+              <encodedKeySize>36</encodedKeySize>
+              <encodedKeyData>
+      unVmAfPQFd5t4cakBxbE7uosu4tzZbo8B513iGGNynzArOKM=
+              </encodedKeyData>
+              <saltLen>20</saltLen>
+              <saltData>
+      IcFy11sZw/w7juCI+Cro8AZVp6Q
+              </saltData>
+              <kdfIterations>97493</kdfIterations>
+              <desiredKDFDuration>500</desiredKDFDuration>
+      </config>
+      </boost_serialization>
+      """
+  }
+end
+
+When /^I run with a lock file present "(.*)"$/ do |cmd|
+  lockfile = File.join(current_dir, 'revenc.lck')
+  Revenc::Mutex.new(lockfile).execute do
+    run(unescape(cmd))
+  end
+end
+
+Then /^the folder "([^\"]*)" should not be mounted$/ do |folder_name|
+  folder = Revenc::FileFolder.new(File.join(current_dir, folder_name))
+  folder.exists?.should be_true
+  folder.should be_empty
+end
+
+Then /^the folder "([^\"]*)" should be mounted$/ do |folder_name|
+  folder = Revenc::FileFolder.new(File.join(current_dir, folder_name))
+  folder.exists?.should be_true
+  folder.should_not be_empty
+end
+

data/features/support/aruba.rb

@@ -0,0 +1,21 @@
+require 'aruba'
+require 'fileutils'
+
+APP_BIN_PATH = File.join(ENV['PWD'], 'bin', 'revenc')
+
+module Aruba
+  module Api
+
+   alias_method :old_run, :run
+
+    # override aruba 
+    def run(cmd)
+      
+      # run development version in verbose mode
+      cmd = cmd.gsub(/^revenc/, "#{APP_BIN_PATH} --verbose")
+
+      # run original aruba 'run' 
+      old_run(cmd)
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'revenc'
+require 'aruba'
+require 'spec/expectations'

data/features/support/hooks.rb

@@ -0,0 +1,6 @@
+After('@unmount_after') do
+  # unmount, no harm done if not mounted
+  in_current_dir do
+    `fusermount -u encrypted_destination_folder 2>&1`
+  end
+end

data/features/unmount.feature

@@ -0,0 +1,58 @@
+@unmount_after @announce
+Feature: Unmounting a reverse mounted encrypted folder using encfs
+
+  As a user with an encfs encrypted data folder
+  I need to unmount an encrypted folder
+  In order to preserve resources
+
+  Background: Successful mount
+    Given a directory named "unencrypted_source_folder"
+    Given an empty file named "unencrypted_source_folder/test_data.txt"
+    Given a directory named "encrypted_destination_folder"
+    Given a valid encfs keyfile named "encfs6.xml"
+    Given a file named "passphrase" with:
+      """
+      test
+      """
+    And I successfully run "revenc mount unencrypted_source_folder encrypted_destination_folder"
+    
+  Scenario: Successful unmount
+    When I run "revenc unmount encrypted_destination_folder"
+    Then the exit status should be 0
+    And the folder "encrypted_destination_folder" should not be mounted
+    
+
+  Scenario: Successful unmount dry run
+    When I run "revenc --dry-run unmount encrypted_destination_folder"
+    Then the exit status should be 0
+    And the folder "encrypted_destination_folder" should be mounted
+
+  Scenario: Unmount folder not specified
+    When I run "revenc unmount"
+    Then the exit status should be 1
+    And I should see:
+      """
+      mountpoint not specified
+      """
+
+  Scenario: Unmount folder doesn't exist
+    Given a directory named "encrypted_destination_folder"
+    When I run "revenc unmount unencrypted_source_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      folder not found
+      """
+
+  Scenario: Missing executable
+    Given a file named "revenc.conf" with:
+      """
+      unmount:
+        executable: missing_bin_file
+      """
+    When I run "revenc unmount unencrypted_source_folder"
+    Then the exit status should be 1
+    And I should see:
+      """
+      executable not found
+      """