ftpspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbd5a0a229210a2cf9339b806b53609060e51164
+  data.tar.gz: cdd7137b58d9307673fdb27fa7ea20e6ee905ca5
+SHA512:
+  metadata.gz: c949188b95fc02f23c69c9a91c76456be7ed3674d88469ed366df2a3a8121d6492111d1befe47016fd528250e5e68f90f39dfab6b7b8424d7019f27a1c124dab
+  data.tar.gz: ebacd76005ad7676dbd766044683eaaffcc16c47d75d7931c405aae2706126bb38814ad08db2606a5a9a7266a696ca512c2d6c301101e458999562b65fa4c7f1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+before_script:
+  - bundle install
+script:
+  - rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ftpspec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+[![Build Status](https://travis-ci.org/suzuki86/ftpspec.svg?branch=master)](https://travis-ci.org/suzuki86/ftpspec)
+
+# Work in progress
+
+This project is under development.
+
+# FTPSpec
+
+RSpec custom matchers for ftp server that enables you to test file structure like Serverspec.
+
+## Installation
+
+Clone to your machine.
+
+```
+git clone https://github.com/suzuki86/ftpspec.git
+```
+
+Move to directory you cloned.
+
+```
+cd ftpspec
+```
+
+Create a gem from ftpspec.gemspec with `gem build`.
+
+```
+gem build ftpspec.gemspec
+```
+
+Install generated ftpspec-x.x.x.gem with `gem install`
+
+```
+gem install ftpspec-x.x.x.gem
+```
+
+## Usage
+
+Execute ftpspec-init command.
+
+```
+ftpspec-init
+```
+
+Then, spec directory will be generated.
+
+```
+$ tree
+.
+├── Rakefile
+└── spec
+    ├── ftp_spec.rb
+    └── spec_helper.rb
+
+1 directory, 3 files
+```
+
+Write credentials of ftp server into spec/spec_helper.rb
+
+```ruby
+require "ftpspec"
+require "rubygems"
+require "rspec"
+require "net/ftp"
+
+RSpec.configure do |c| 
+  c.add_setting :ftp, :default => nil 
+  c.before do
+    hostname = "YOUR HOSTNAME"
+    user = "YOUR USER"
+    password = "YOUR PASSWORD"
+    c.ftp = Net::FTP.new
+    c.ftp.passive = true
+    c.ftp.connect(hostname)
+    c.ftp.login(user, password)
+    Ftpspec.set_ftp
+  end 
+  c.after do
+    c.ftp.close
+  end 
+end
+```
+
+Write spec in each spec files.
+
+```ruby
+require "spec_helper"
+
+describe "/httpdocs/index.html" do
+  it { should be_mode 644 }
+end
+```
+
+Execute rake command.
+
+```
+rake spec
+```
+
+## Matchers
+
+### be_mode
+
+Test whether file permission of subject is same as expected.
+
+```
+describe "/httpdocs/index.html" do
+  it { should be_mode 644 }
+end
+```
+
+### be_file
+
+Test whether subject is a file.
+
+```
+describe "/httpdocs/index.html" do
+  it { should be_file }
+end
+```
+
+### be_directory
+
+Test whether subject is a directory.
+
+```
+describe "/httpdocs/images" do
+  it { should be_directory }
+end
+```
+
+### be_owned_by
+
+Test whether subject is owned by expected owner.
+
+```
+describe "/httpdocs/index.html" do
+  it { should be_owned_by "someone" }
+end
+```
+
+### be_grouped_into
+
+Test whether subject is grouped into expected group.
+
+```
+describe "/httpdocs/index.html" do
+  it { should be_grouped_into "admin" }
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ftpspec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/ftpspec-init

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "ftpspec"
+
+Ftpspec::Setup.run

data/ftpspec.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ftpspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ftpspec"
+  spec.version       = Ftpspec::VERSION
+  spec.authors       = ["Toshinari Suzuki"]
+  spec.email         = ["tsnr0001@gmail.com"]
+  spec.summary       = %q{RSpec custom matchers for ftp server.}
+  spec.description   = %q{RSpec custom matchers for ftp server.}
+  spec.homepage      = "https://github.com/suzuki86/ftpspec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = "ftpspec-init"
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/ftpspec/commands.rb

@@ -0,0 +1,121 @@
+module Ftpspec
+  class Commands
+
+    def self.check_mode(target, expected)
+      ftp = Ftpspec.get_ftp
+      ftp.chdir File.dirname(target)
+      ftp.list.each do |file|
+        part = file.split(" ")
+        if part[8] != "." && part[8] != ".." then
+          current_path = ftp.pwd
+          filemode = part[0]
+
+          if current_path == "/" then
+            filename = "/" + part[8]
+          else
+            filename = current_path + "/" + part[8]
+          end
+
+          if filename == target then
+            return Ftpspec::Utils.convert_to_octal(filemode).to_i == expected          
+          end
+        end
+      end
+      return false
+    end
+
+    def self.check_file(target)
+      ftp = Ftpspec.get_ftp
+      ftp.chdir File.dirname(target)
+      ftp.list.each do |file|
+        part = file.split(" ")
+        if part[8] != "." && part[8] != ".." then
+          current_path = ftp.pwd
+          filemode = part[0]
+
+          if current_path == "/" then
+            filename = "/" + part[8]
+          else
+            filename = current_path + "/" + part[8]
+          end
+
+          if filename == target then
+            return filemode[0] == "-"
+          end
+        end
+      end
+      return false
+    end
+
+    def self.check_directory(target)
+      ftp = Ftpspec.get_ftp
+      ftp.chdir File.dirname(target)
+      ftp.list.each do |file|
+        part = file.split(" ")
+        if part[8] != "." && part[8] != ".." then
+          current_path = ftp.pwd
+          filemode = part[0]
+
+          if current_path == "/" then
+            filename = "/" + part[8]
+          else
+            filename = current_path + "/" + part[8]
+          end
+
+          if filename == target then
+            return filemode[0] == "d"
+          end
+        end
+      end
+      return false
+    end
+
+    def self.check_owner(target, expected)
+      ftp = Ftpspec.get_ftp
+      ftp.chdir File.dirname(target)
+      ftp.list.each do |file|
+        part = file.split(" ")
+        if part[8] != "." && part[8] != ".." then
+          current_path = ftp.pwd
+          filemode = part[0]
+          owner = part[2]
+
+          if current_path == "/" then
+            filename = "/" + part[8]
+          else
+            filename = current_path + "/" + part[8]
+          end
+
+          if filename == target then
+            return owner == expected
+          end
+        end
+      end
+      return false
+    end
+
+    def self.check_group(target, expected)
+      ftp = Ftpspec.get_ftp
+      ftp.chdir File.dirname(target)
+      ftp.list.each do |file|
+        part = file.split(" ")
+        if part[8] != "." && part[8] != ".." then
+          current_path = ftp.pwd
+          filemode = part[0]
+          group = part[3]
+
+          if current_path == "/" then
+            filename = "/" + part[8]
+          else
+            filename = current_path + "/" + part[8]
+          end
+
+          if filename == target then
+            return group == expected
+          end
+        end
+      end
+      return false
+    end
+  end
+end

data/lib/ftpspec/matchers.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :be_mode do |expected|
+  match do |target|
+    Ftpspec::Commands.check_mode(target, expected)
+  end
+end
+
+RSpec::Matchers.define :be_file do
+  match do |target|
+    Ftpspec::Commands.check_file(target)
+  end
+end
+
+RSpec::Matchers.define :be_directory do
+  match do |target|
+    Ftpspec::Commands.check_directory(target)
+  end
+end
+
+RSpec::Matchers.define :be_owned_by do |expected|
+  match do |target|
+    Ftpspec::Commands.check_owner(target, expected)
+  end
+end
+
+RSpec::Matchers.define :be_grouped_into do
+  match do |target|
+    Ftpspec::Commands.check_group(target, expected)
+  end
+end

data/lib/ftpspec/setup.rb

@@ -0,0 +1,62 @@
+require "fileutils"
+
+module Ftpspec
+  class Setup
+    def self.run
+
+      file_contents = <<-EOF
+require "spec_helper"
+
+describe "/httpdocs/index.html" do
+  it { should be_mode 644 }
+end
+      EOF
+
+      rakefile_contents = <<-EOF
+require "rake"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/*/*_spec.rb"
+end
+
+task :default => :spec
+      EOF
+
+      spec_helper_contents = <<-EOF
+require "ftpspec"
+require "rubygems"
+require "rspec"
+require "net/ftp"
+
+RSpec.configure do |c|
+  c.add_setting :ftp, :default => nil
+  c.before do
+    hostname = ""
+    user = ""
+    password = ""
+    c.ftp = Net::FTP.new
+    c.ftp.passive = true
+    c.ftp.connect(hostname)
+    c.ftp.login(user, password)
+    Ftpspec.set_ftp
+  end
+  c.after do
+    c.ftp.close
+  end
+end
+      EOF
+
+      FileUtils.mkdir "spec"
+      File.open("spec/ftp_spec.rb", "w") do |f|
+        f.puts file_contents
+      end
+      File.open("spec/spec_helper.rb", "w") do |f|
+        f.puts spec_helper_contents
+      end
+      File.open("Rakefile", "w") do |f|
+        f.puts rakefile_contents
+      end
+    end
+  end
+end

data/lib/ftpspec/utils.rb

@@ -0,0 +1,34 @@
+module Ftpspec
+  class Utils
+    def self.convert_to_octal(str)
+      if str.length != 10
+        raise
+      end
+
+      octal = Array.new(3)
+      3.times do |i|
+        octal[i] = 0
+      end
+
+      3.times do |i|
+        3.times do |j|
+
+          str_key = j + 1 + (3 * i)
+          octal_key = (i % 3) + (i / 3)
+
+          if str[str_key] == "r" then
+            octal[octal_key] += 4
+          end
+          if str[str_key] == "w" then
+            octal[octal_key] += 2
+          end
+          if str[str_key] == "x" then
+            octal[octal_key] += 1
+          end
+
+        end
+      end
+      octal.join("").to_i
+    end
+  end
+end

data/lib/ftpspec/version.rb

@@ -0,0 +1,3 @@
+module Ftpspec
+  VERSION = "0.0.1"
+end

data/lib/ftpspec.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "rspec"
+require "ftpspec/version"
+require "ftpspec/setup"
+require "ftpspec/matchers"
+require "ftpspec/commands"
+require "ftpspec/utils"
+
+module Ftpspec
+  @@ftp = nil
+  def self.set_ftp
+    @@ftp = RSpec.configuration.ftp
+  end
+  def self.get_ftp
+    @@ftp
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,128 @@
+require "spec_helper"
+
+describe "Ftpspec::Commands" do
+
+  before :all do
+    class Ftp
+      def chdir(target)
+        "/httpdocs"
+      end
+      def list
+        [
+          "drwxr-xr-x  25 owner_name group_name      4096 Aug  3 19:57 .", 
+          "drwxr-xr-x  13 root     root         4096 Oct 22  2012 ..",
+          "-rw-r--r--   1 owner_name group_name      26482 Jul 19  2010 index.php",
+          "drwxr-xr-x   4 owner_name group_name       4096 Oct 17  2010 dir"
+        ]
+      end
+      def pwd
+      end
+    end
+    @ftp = Ftp.new
+  end
+
+  describe ".check_mode" do
+    it "returns true" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_mode("/httpdocs/index.php", 644)
+      expect(actual).to be true
+    end
+    it "returns true" do
+      allow(@ftp).to receive(:pwd) { "/" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_mode("/index.php", 644)
+      expect(actual).to be true
+    end
+    it "returns false" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_mode("/httpdocs/index.php", 645)
+      expect(actual).to be false
+    end
+  end
+
+  describe ".check_file" do
+    it "returns true" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_file("/httpdocs/index.php")
+      expect(actual).to be true
+    end
+    it "returns true" do
+      allow(@ftp).to receive(:pwd) { "/" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_file("/index.php")
+      expect(actual).to be true
+    end
+    it "returns false" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_file("/httpdocs/dir")
+      expect(actual).to be false
+    end
+  end
+
+  describe ".check_directory" do
+    it "returns true" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_directory("/httpdocs/dir")
+      expect(actual).to be true
+    end
+    it "returns true" do
+      allow(@ftp).to receive(:pwd) { "/" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_directory("/dir")
+      expect(actual).to be true
+    end
+    it "returns false" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_directory("/httpdocs/index.php")
+      expect(actual).to be false
+    end
+  end
+
+  describe ".check_owner" do
+    it "returns true if owner name is valid" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_owner("/httpdocs/index.php", "owner_name")
+      expect(actual).to be true
+    end
+    it "returns true if owner name is valid" do
+      allow(@ftp).to receive(:pwd) { "/" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_owner("/index.php", "owner_name")
+      expect(actual).to be true
+    end
+    it "returns false if owner name is invalid" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_owner("/httpdocs/index.php", "invalid_owner")
+      expect(actual).to be false
+    end
+  end
+
+  describe ".check_group" do
+    it "returns true if group name is valid" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_group("/httpdocs/index.php", "group_name")
+      expect(actual).to be true
+    end
+    it "returns true if group name is valid" do
+      allow(@ftp).to receive(:pwd) { "/" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_group("/index.php", "group_name")
+      expect(actual).to be true
+    end
+    it "returns false if group name is invalid" do
+      allow(@ftp).to receive(:pwd) { "/httpdocs" }
+      allow(Ftpspec).to receive(:get_ftp) { @ftp }
+      actual = Ftpspec::Commands.check_group("/httpdocs/index.php", "invalid_owner")
+      expect(actual).to be false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "ftpspec"

data/spec/utils_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe ".convert_to_octal" do
+  actual = Ftpspec::Utils.convert_to_octal "-rwxrwxrwx"
+  it "should be 777" do
+    expect(actual).to eq(777)
+  end
+end
+
+describe ".convert_to_octal" do
+  actual = Ftpspec::Utils.convert_to_octal "-rw-r--r--"
+  it "should be 644" do
+    expect(actual).to eq(644)
+  end
+end
+
+describe ".convert_to_octal" do
+  actual = Ftpspec::Utils.convert_to_octal "----------"
+  it "should be 000" do
+    expect(actual).to eq(000)
+  end
+end
+
+describe ".convert_to_octal" do
+  it "should be raised error" do
+    expect do
+      Ftpspec::Utils.convert_to_octal("---------")
+    end.to raise_error
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: ftpspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toshinari Suzuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec custom matchers for ftp server.
+email:
+- tsnr0001@gmail.com
+executables:
+- ftpspec-init
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ftpspec-init
+- ftpspec.gemspec
+- lib/ftpspec.rb
+- lib/ftpspec/commands.rb
+- lib/ftpspec/matchers.rb
+- lib/ftpspec/setup.rb
+- lib/ftpspec/utils.rb
+- lib/ftpspec/version.rb
+- spec/command_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
+homepage: https://github.com/suzuki86/ftpspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RSpec custom matchers for ftp server.
+test_files:
+- spec/command_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb