syc-backup 0.0.4

data/test/test_environment.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'shoulda'
+require_relative '../lib/backup/environment'
+
+# Tests Environment class to return the variables neccessary for running a
+# Ruby application as a cron job
+class TestEnvironment < Test::Unit::TestCase
+
+  context "Environment" do
+
+    should "return specified environment variables" do
+      vars = Backup::Environment::VARIABLES
+
+      extract = Backup::Environment.ruby
+      extract.each do |line|
+        assert_includes vars, line.match(/\A\w+(?=\=)/).to_s.upcase
+      end
+
+    end
+
+  end
+end

data/test/test_file_backup.rb

@@ -0,0 +1,70 @@
+require 'test/unit'
+require 'shoulda'
+require 'fileutils'
+require_relative '../lib/backup/file_backup.rb'
+
+# Tests the FileBackup class.
+class TestFileBackup < Test::Unit::TestCase
+
+  context "Providing erroneous user input" do
+
+    should "return error code 1 due to non existend file" do
+      fbu = Backup::FileBackup.new(["f1"])
+      begin
+        backup_files = fbu.backup "test/backup"
+      rescue SystemExit => e
+        assert_equal 1, e.status
+      end
+    end
+
+    should "return error code 1 due to non existend file within list" do
+      fbu = Backup::FileBackup.new(["f1","f2","f3"])
+      begin
+        backup_files = fbu.backup "test/backup"
+      rescue SystemExit => e
+        assert_equal 1, e.status
+      end
+    end
+
+    should "return error code 2 due to non existend file to compress" do
+      fbu = Backup::FileBackup.new
+      begin
+        backup_files = fbu.compress(["a","b","c"], "test/backup")
+        flunk "expected error code 2"
+      rescue SystemExit => e
+        assert_equal 2, e.status
+      end
+    end
+  end
+
+  context "Providing valid user input" do
+
+    # Create files to be backed up
+    def setup
+      ["file1", "file2", "file3"].each {|f| FileUtils.touch f}
+    end
+
+    # Remove files previously created with setup and all created files and
+    # directories during processing backups
+    def teardown
+      ["file1", "file2", "file3"].each {|f| FileUtils.rm f}
+      Dir["test/backup/file*"].each {|f| FileUtils.rm f}
+      Dir["test/backup/*.tar.gz"].each {|f| FileUtils.rm f}
+      Dir.rmdir "test/backup" if File.exists? "test/backup"
+    end
+
+    should "backup file in specified folder" do
+      fbu = Backup::FileBackup.new(["file1"])
+      backup_files = fbu.backup("test/backup")
+      assert_equal ["test/backup/file1"], backup_files
+    end
+
+    should "return compressed file in specified folder" do
+      fbu = Backup::FileBackup.new(["file1", "file2", "file3"])
+      backup_files = fbu.backup("test/backup/")
+      assert_equal 0, fbu.compress(backup_files, "test/backup")
+    end
+
+  end
+
+end

data/test/test_mysql_backup.rb

@@ -0,0 +1,71 @@
+require 'test/unit'
+require 'shoulda'
+
+require_relative '../lib/backup/mysql_backup.rb'
+
+# Tests for MySQLBackup class.
+# 
+# Expects a running MySQL database server with following data
+# table::    test
+# user::     user
+# password:: pass
+# 
+class TestMySQLBackup < Test::Unit::TestCase
+
+  context "Providing erroneous user input" do
+
+    should "return error code 1 due to mysqldump error" do
+      myb = Backup::MySQLBackup.new("database", "user", "password")
+      begin
+        myb.backup
+        flunk(message="Expected a SystemExit!")
+      rescue SystemExit => e
+        assert_equal 1, e.status
+      end
+    end
+
+    should "return error code 2 due to compress error" do
+      myb = Backup::MySQLBackup.new("database", "user", "password")
+      begin
+        myb.compress("unexistent_file")
+        flunk(message="Expected a SystemExit!")
+      rescue SystemExit => e
+        assert_equal 2, e.status
+      end
+    end
+
+  end
+  
+  context "Providing valid user input" do
+
+    setup do
+      @mbu = Backup::MySQLBackup.new("test", "pierre", "pass")
+    end
+
+    teardown do
+      Dir["test_*"].each { |file| File.delete file }
+      Dir["test/backup/test_*"].each { |file| File.delete file }
+      Dir.rmdir "test/backup" if File.exists? "test/backup"
+    end
+
+    should "create a database backup file in the default folder" do
+      backup_file = @mbu.backup
+      assert_match /\.\/test_\d{8}-\d{6}/, backup_file
+    end
+
+    should "create a database backup file in the provided backup folder" do
+      backup_file = @mbu.backup("test/backup/")
+      assert_match /test\/backup\/test_\d{8}-\d{6}/, backup_file
+    end
+
+    should "create a compressed file in the default folder" do
+      backup_file = @mbu.backup
+      assert 0 == @mbu.compress(backup_file)
+    end
+    
+    should "create a compressed file in the provided backup folder" do
+      backup_file = @mbu.backup("test/backup/")
+      assert 0 == @mbu.compress(backup_file)
+    end
+  end
+end

data/test/test_options.rb

@@ -0,0 +1,189 @@
+require 'test/unit'
+require 'shoulda'
+require_relative '../lib/backup/options'
+
+# Test that user input is correctly interpreted and provided to other classes
+# over methods.
+class TestOptions < Test::Unit::TestCase
+
+  context "Erroneous user input" do
+    should "return error code 16 due to missing database and files" do
+      begin
+        opts = Backup::Options.new(["--no-compress", "--override",
+                                    "~/backup/old"])
+      rescue SystemExit => e
+        assert_equal 16, e.status
+      end
+    end
+
+    should "return error code 16 due to no database input" do
+      begin
+        opts = Backup::Options.new(["-u", "user", "-p", "pass"])
+      rescue SystemExit => e
+        assert_equal 16, e.status
+      end
+    end
+
+    should "return error code 2 due to missing user" do
+      begin
+        opts = Backup::Options.new(["-d", "database", "-p", "pass"])
+      rescue SystemExit => e
+        assert_equal 2, e.status
+      end
+    end
+
+    should "return error code 4 due to missing password" do
+      begin
+        opts = Backup::Options.new(["-d", "database", "-u", "user"])
+      rescue SystemExit => e
+        assert_equal 4, e.status
+      end
+    end
+
+    should "return error code 16 due to missing database and user" do
+      begin
+        opts = Backup::Options.new(["-p", "pass"])
+      rescue SystemExit => e
+        assert_equal 16, e.status
+      end
+    end
+
+    should "return error code 6 due to missing user and password" do
+      begin
+        opts = Backup::Options.new(["-d", "database"])
+      rescue SystemExit => e
+        assert_equal 6, e.status
+      end
+    end
+
+    should "return error code 1 due to missing database" do
+      begin
+        opts = Backup::Options.new(["-f", "a,b,c", "-u", "user", "-p", "pass"])
+      rescue SystemExit => e
+        assert_equal 1, e.status
+      end
+    end
+
+    should "return error code 3 due to missing database and user" do
+      begin
+        opts = Backup::Options.new(["-f", "a", "-p", "pass"])
+      rescue SystemExit => e
+        assert_equal 3, e.status
+      end
+    end
+
+    should "return error code -1 due to wrong switch and flag" do
+      begin
+        opts = Backup::Options.new(["-x"])
+      rescue SystemExit => e
+        assert_equal -1, e.status
+      end
+    end
+
+    should "return error code -1 due to missing argument for -f" do
+      begin
+        opts = Backup::Options.new(["-f"])
+      rescue SystemExit => e
+        assert_equal -1, e.status
+      end
+    end
+
+    should "return error code 8 due to wrong cron values" do
+      begin
+        opts = Backup::Options.new(["-d", "database", "-u", "user", "-p", 
+                                    "pass", "--cron", "60,24,32,*,d,e"])
+      rescue SystemExit => e
+        assert_equal 8, e.status
+      end
+    end
+
+  end
+
+  context "Correct user input" do
+
+    should "return database, user, password and default backup_folder" do
+      default_backup_folder_exists = 
+        File.exists? Backup::Options::DEFAULT_BACKUP_FOLDER
+      opts = Backup::Options.new(["-d", "database", "-u", "user", "-p", "pass"])
+      assert_equal "database", opts.database
+      assert_equal "user", opts.user
+      assert_equal "pass", opts.password
+      unless default_backup_folder_exists
+        assert_match Backup::Options::DEFAULT_BACKUP_FOLDER, opts.backup_folder
+      else
+        assert_match /#{Backup::Options::DEFAULT_BACKUP_FOLDER}_\d{8}-\d{6}\//, 
+                     opts.backup_folder
+      end
+    end
+
+    should "return database and specified backup folder" do
+      opts = Backup::Options.new(["-d", "database", "-u", "user", "-p", "pass",
+                                  "~/backups/2013/drupal"])
+      assert_equal "database", opts.database
+      assert_equal File.expand_path("~/backups/2013/drupal/"),
+                   File.expand_path(opts.backup_folder)
+    end
+
+    should "return database and file" do
+      opts = Backup::Options.new(["-d", "database", "-u", "user", "-p", "pass",
+                                  "-f", "file_a"])
+      assert_equal "database", opts.database
+      assert_equal "file_a", opts.files[0]
+    end
+
+    should "return database, files and cron schedule" do
+      opts = Backup::Options.new(["-d", "database", "-u", "user", "-p", "pass",
+                                  "-f", "file_a,file_b", 
+                                  "--cron", "15 3 * * *"])
+      assert_equal "database", opts.database
+      assert_equal 2, opts.files.size
+      assert_equal "15 3 * * *", opts.cron
+    end
+
+    should "return cron schedule even though too many arguments" do
+      opts = Backup::Options.new(["-d", "database", "-u", "user", "-p", "pass",
+                                  "--cron", "15 3 * 1 7 * * a"])
+      assert_equal "15 3 * 1 7", opts.cron
+    end
+
+    should "return without error (error code = 0) and print version" do
+      begin
+        opts = Backup::Options.new(["-v"])
+      rescue SystemExit => e
+        assert e.status == 0
+      end
+    end
+
+    should "return without error (error code = 0) and print help" do
+      begin
+        opts = Backup::Options.new(["-h"])
+      rescue SystemExit => e
+        assert e.status == 0
+      end
+    end
+
+    should "return files provided by user" do
+      opts = Backup::Options.new(["-f", "a,b,c"])
+      assert_equal ["a","b","c"], opts.files
+    end
+
+    should "return files stripped off trailing and leading blanks" do
+      opts = Backup::Options.new(["-f", "a, b, c "])
+      assert_equal ["a","b","c"], opts.files
+    end
+
+    should "return override" do
+      opts = Backup::Options.new(["-f", "a,b,c", "~/backup/new", 
+                                  "--override"])
+      assert_equal ["a","b","c"], opts.files
+      assert_equal true, opts.override
+    end
+
+    should "return no-compress" do
+      opts = Backup::Options.new(["-f", "a,b,c", "--no-compress"])
+      assert_equal true, opts.no_compress
+    end
+
+  end
+
+end

data/test/test_process.rb

@@ -0,0 +1,40 @@
+require 'test/unit'
+require 'shoulda'
+require 'fileutils'
+require_relative '../lib/backup/process.rb'
+
+# Test for the Process class. Tests copy and compress commands
+class TestProcess < Test::Unit::TestCase
+
+  context "Process" do
+
+    # Create files to backup
+    def setup
+      @files = ["file1", "file2", "file3"]
+      @files.each {|f| FileUtils.touch f}
+    end
+
+    # Remove files that have created with setup and all files and directories
+    # created during backup processing
+    def teardown
+      @files.each {|f| File.delete f}
+      Dir["test/backup_p/*"].each {|f| File.delete f if File.file? f}
+    end
+
+    should "backup files to provided folder without compressing" do
+      pro = Backup::Process.new("test/backup_p/", @files, false, true)
+      pro.backup
+      Dir["test/backup_p/*"].each do |f|
+        assert_equal 1, @files.count(File.basename(f))
+      end
+    end
+
+    should "compress files to provided folder" do
+      pro = Backup::Process.new("test/backup_p/", @files, false, false)
+      pro.backup
+      assert_equal 1, Dir["test/backup_p/*.tar.gz"].size
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: syc-backup
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Pierre Sugar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies: []
+description: ! "Back up a database and files or schedule cron job \n                      for
+  backup"
+email: pierre@sugaryourcoffee.de
+executables:
+- sycbackup
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- syc-backup-0.0.3.gem
+- test/test_process.rb
+- test/test_mysql_backup.rb
+- test/test_options.rb
+- test/test_cron_edit.rb
+- test/test_environment.rb
+- test/test_file_backup.rb
+- sycbackup.gemspec
+- lib/backup_version.rb
+- lib/backup/file_backup.rb
+- lib/backup/process.rb
+- lib/backup/mysql_backup.rb
+- lib/backup/options.rb
+- lib/backup/cron_edit.rb
+- lib/backup/environment.rb
+- lib/backup/runner.rb
+- doc/TestProcess.html
+- doc/README_rdoc.html
+- doc/TestEnvironment.html
+- doc/Rakefile.html
+- doc/TestFileBackup.html
+- doc/table_of_contents.html
+- doc/Backup/FileBackup.html
+- doc/Backup/Environment.html
+- doc/Backup/Options.html
+- doc/Backup/Runner.html
+- doc/Backup/Process.html
+- doc/Backup/CronEdit.html
+- doc/Backup/MySQLBackup.html
+- doc/created.rid
+- doc/js/searcher.js
+- doc/js/search.js
+- doc/js/navigation.js
+- doc/js/search_index.js
+- doc/js/jquery.js
+- doc/js/darkfish.js
+- doc/Backup.html
+- doc/index.html
+- doc/TestCronEdit.html
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/package.png
+- doc/images/wrench.png
+- doc/images/page_white_width.png
+- doc/images/wrench_orange.png
+- doc/images/delete.png
+- doc/images/page_green.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/bug.png
+- doc/images/transparent.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/zoom.png
+- doc/images/brick.png
+- doc/images/page_white_text.png
+- doc/images/find.png
+- doc/images/add.png
+- doc/images/brick_link.png
+- doc/images/date.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/plugin.png
+- doc/images/tag_blue.png
+- doc/rdoc.css
+- doc/TestMySQLBackup.html
+- doc/TestOptions.html
+- bin/sycbackup
+- Rakefile
+- syc-backup-0.0.1.gem
+homepage: http://syc.dyndns.org/drupal
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- No requirements
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Back up a database and files
+test_files:
+- test/test_process.rb
+- test/test_mysql_backup.rb
+- test/test_options.rb
+- test/test_cron_edit.rb
+- test/test_environment.rb
+- test/test_file_backup.rb