fake_ftp 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.idea
+pkg/*
+*.gem
+.bundle
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree@fake_ftp --create

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    fake_ftp (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.10)
+  fake_ftp!
+  rake (>= 0.8.7)
+  rspec (> 2)

data/README.markdown

@@ -0,0 +1,81 @@
+FakeFtp
+=======
+
+This is a gem that allows you to test FTP implementations in ruby. It is a minimal single-client FTP server
+that can be bound to any arbitrary port on localhost.
+
+Why?
+----
+
+We want to ensure that our code works, in a way that is agnostic to the implementation used (unlike with stubs or mocks).
+
+How
+---
+
+FakeFtp is a simple FTP server that fakes out enough of the protocol to get us by, allowing us to test that files get to
+their intended destination rather than testing how our code does so.
+
+Note: Only passive FTP is currently implemented
+
+Usage
+-----
+
+    require 'fake_ftp'
+    require 'net/ftp'
+
+    server = FakeFtp::Server.new(21212, 21213)
+    ## 21212 is the control port, which is used by FTP for the primary connection
+    ## 21213 is the data port, used in FTP passive mode to send file contents
+    server.start
+
+    ftp = Net::FTP.new
+    ftp.connect('127.0.0.1', 21212)
+    ftp.login('user', 'password')
+    ftp.passive = true
+    ftp.put('some_file.txt')
+    ftp.close
+
+    server.stop
+
+TODO
+----
+
+* Active file upload
+* Matchers
+
+References
+----------
+
+* http://rubyforge.org/projects/ftpd/ - a simple ftp daemon written by Chris Wanstrath
+* http://ruby-doc.org/stdlib/libdoc/gserver/rdoc/index.html - a generic server in the Ruby standard library, by John W Small
+
+Contributors
+------------
+
+* Eric Saxby
+* Colin Shield
+
+License
+-------
+
+The MIT License
+
+Copyright (c) 2011 Eric Saxby
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/fake_ftp.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fake_ftp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fake_ftp"
+  s.version     = FakeFtp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Colin Shield", "Eric Saxby"]
+  s.email       = ["sax+github@livinginthepast.org"]
+  s.homepage    = "http://rubygems.org/gems/fake_ftp"
+  s.summary     = %q{Creates a fake FTP server for use in testing}
+  s.description = %q{Testing FTP? Use this!}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = "fake_ftp"
+  
+  s.add_development_dependency "bundler", '>=1.0.10'
+  s.add_development_dependency "rspec", '>2'
+  s.add_development_dependency "rake", '>=0.8.7'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fake_ftp/server.rb

@@ -0,0 +1,155 @@
+require 'socket'
+require "thread"
+
+module FakeFtp
+  class Server
+
+    attr_accessor :directory, :port, :passive_port
+    attr_reader :files
+
+    CMDS = %w[acct cwd cdup pass pasv port pwd quit stor type user]
+    LNBK = "\r\n"
+
+    def initialize(control_port = 21, data_port = nil, options = {})
+      self.port = control_port
+      self.passive_port = data_port
+      raise(Errno::EADDRINUSE, "#{port}") if is_running?
+      raise(Errno::EADDRINUSE, "#{passive_port}") if passive_port && is_running?(passive_port)
+      @connection = nil
+      @data = nil
+      @options = options
+      @files = []
+      self.directory = "#{Rails.root}/tmp/ftp" rescue '/tmp'
+    end
+
+    def start
+      @started = true
+      @server = ::TCPServer.new('127.0.0.1', port)
+      @thread = Thread.new do
+        while @started
+          @client = @server.accept
+          respond_with('200 Can has FTP?')
+          @connection = Thread.new(@client) do |socket|
+            while @started && !socket.nil? && !socket.closed?
+              respond_with parse(socket.gets)
+            end
+            @client.close
+            @client = nil
+          end
+        end
+        @server.close
+        @server = nil
+      end
+
+      if passive_port
+        @data_server = ::TCPserver.new('127.0.0.1', passive_port)
+      end
+    end
+
+    def stop
+      @started = false
+      @client.close if @client
+      @server.close if @server
+      @server = nil
+      @data_server.close if @data_server
+      @data_server = nil
+    end
+
+    def is_running?(tcp_port = nil)
+      service = `lsof -w -n -i tcp:#{tcp_port || port}`
+      !service.nil? && service != ''
+    end
+
+    private
+
+    def respond_with(stuff)
+      @client.print stuff << LNBK unless stuff.nil? or @client.nil? or @client.closed?
+    end
+
+    def parse(request)
+      return if request.nil?
+      puts request if @options[:debug]
+      command = request[0, 4].downcase.strip
+      contents = request.split
+      message = contents[1..contents.length]
+      case command
+        when *CMDS
+          __send__ "_#{command}", message
+        else
+          '500 Unknown command'
+      end
+    end
+
+    def _acct(*args)
+      '230 WHATEVER!'
+    end
+
+    def _cwd(*args)
+      '250 OK!'
+    end
+    alias :_cdup :_cwd
+
+    def _pass(*args)
+      '230 logged in'
+    end
+
+    def _pasv(*args)
+      if passive_port
+        p1 = (passive_port / 256).to_i
+        p2 = passive_port % 256
+        "227 Entering Passive Mode (127,0,0,1,#{p1},#{p2})"
+      else
+        '502 Aww hell no, use Active'
+      end
+    end
+
+    def _port(remote)
+      # remote = remote.split(',')
+      # remote_port = remote[4].to_i * 256 + remote[5].to_i
+      # unless @data_connection.nil?
+      #   @data_connection.close
+      #   @data_connection = nil
+      # end
+      # puts remote_port
+      # @data_connection = ::TCPSocket.open('127.0.0.1', remote_port)
+      # '200 Okay'
+      '500 Not implemented yet'
+    end
+
+    def _pwd(*args)
+      "257 \"#{self.directory}\" is current directory"
+    end
+
+    def _quit(*args)
+      respond_with '221 OMG bye!'
+      @client.close if @client
+      @client = nil
+    end
+
+    def _stor(filename)
+      @files << File.basename(filename.to_s)
+      respond_with('125 Do it!')
+
+      data_client = @data_server.accept
+      @data = data_client.recv(1024)
+
+      data_client.close
+      '226 Did it!'
+    end
+
+    def _type(type = 'A')
+      case type.to_s
+        when 'A'
+          '200 Type set to A.'
+        when 'I'
+          '200 Type set to I.'
+        else
+          '504 We don\'t allow those'
+      end
+    end
+
+    def _user(name = '')
+      (name.to_s == 'anonymous') ? '230 logged in' : '331 send your password'
+    end
+  end
+end

data/lib/fake_ftp/version.rb

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

data/lib/fake_ftp.rb

@@ -0,0 +1,4 @@
+require 'fake_ftp/server'
+
+module FakeFtp
+end

data/spec/fixtures/text_file.txt

@@ -0,0 +1 @@
+Hello im a text file

data/spec/models/fake_ftp/server_spec.rb

@@ -0,0 +1,353 @@
+require "spec_helper.rb"
+require 'net/ftp'
+
+describe FakeFtp::Server do
+
+  before :each do
+    @directory = File.expand_path("../fixtures/destination", File.dirname(__FILE__))
+    @text_filename = File.expand_path("../../fixtures/text_file.txt", File.dirname(__FILE__))
+    @bin_filename = File.expand_path("../../fixtures/invisible_bike.jpg", File.dirname(__FILE__))
+  end
+
+  after :each do
+    FileUtils.rm_rf(@directory+"/*")
+  end
+
+  context 'setup' do
+    it "starts a server on port n" do
+      server = FakeFtp::Server.new(21212)
+      server.port.should == 21212
+    end
+
+    it "should defaults to port 21" do
+      server = FakeFtp::Server.new
+      server.port.should == 21
+    end
+
+    it "starts a passive server on port p" do
+      server = FakeFtp::Server.new(21212, 21213)
+      server.passive_port.should == 21213
+    end
+
+    it "should start and stop" do
+      server = FakeFtp::Server.new(21212)
+      server.is_running?.should be_false
+      server.start
+      server.is_running?.should be_true
+      server.stop
+      server.is_running?.should be_false
+    end
+
+    it "should start and stop passive port" do
+      server = FakeFtp::Server.new(21212, 21213)
+      server.is_running?(21213).should be_false
+      server.start
+      server.is_running?(21213).should be_true
+      server.stop
+      server.is_running?(21213).should be_false
+    end
+
+    it "should raise if attempting to use a bound port" do
+      server = FakeFtp::Server.new(21212)
+      server.start
+      proc { FakeFtp::Server.new(21212) }.should raise_error(Errno::EADDRINUSE, "Address already in use - 21212")
+      server.stop
+    end
+
+    it "should raise if attempting to use a bound passive_port" do
+      server = FakeFtp::Server.new(21212, 21213)
+      server.start
+      proc { FakeFtp::Server.new(21214, 21213) }.should raise_error(Errno::EADDRINUSE, "Address already in use - 21213")
+      server.stop
+    end
+
+    it "can be configured with a directory store" do
+      server = FakeFtp::Server.new
+      server.directory = @directory
+      server.directory.should == @directory
+    end
+
+    it "should default directory to /tmp if Rails.root does not exist" do
+      server = FakeFtp::Server.new
+      server.directory.should == '/tmp'
+    end
+
+    it "should default directory to Rails.root/tmp/ftp if exists" do
+      module Rails; end
+      Rails.stub!(:root).and_return('/somewhere')
+      server = FakeFtp::Server.new
+      server.directory.should == '/somewhere/tmp/ftp'
+    end
+
+    it "should clean up directory after itself"
+
+    it "should raise if attempting to delete a directory with contents other than its own"
+  end
+
+  context 'socket' do
+    before :each do
+      @server = FakeFtp::Server.new(21212, 21213)
+      @server.start
+    end
+
+    after :each do
+      @server.stop
+      @server = nil
+    end
+
+    context 'FTP commands' do
+      context 'general' do
+        before :each do
+          @client = TCPSocket.open('127.0.0.1', 21212)
+        end
+
+        after :each do
+          @client.close
+        end
+
+        it "should accept connections" do
+          @client.gets.should == "200 Can has FTP?\r\n"
+        end
+
+        it "should get unknown command response when nothing is sent" do
+          @client.gets
+          @client.puts
+          @client.gets.should == "500 Unknown command\r\n"
+        end
+
+        it "accepts QUIT" do
+          @client.gets
+          @client.puts "QUIT"
+          @client.gets.should == "221 OMG bye!\r\n"
+        end
+
+        it "should accept multiple commands in one session" do
+          @client.gets
+          @client.puts "USER thing"
+          @client.gets
+          @client.puts "PASS thing"
+          @client.gets
+          @client.puts "ACCT thing"
+          @client.gets
+          @client.puts "USER thing"
+        end
+      end
+
+      context 'passive' do
+        after :each do
+          @client.close
+        end
+
+        it "accepts PASV" do
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets
+          @client.puts "PASV"
+          @client.gets.should == "227 Entering Passive Mode (127,0,0,1,82,221)\r\n"
+        end
+
+        it "responds with correct PASV port" do
+          @server.stop
+          @server.passive_port = 21111
+          @server.start
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets
+          @client.puts "PASV"
+          @client.gets.should == "227 Entering Passive Mode (127,0,0,1,82,119)\r\n"
+        end
+
+        it "does not accept PASV if no port set" do
+          @server.stop
+          @server.passive_port = nil
+          @server.start
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets
+          @client.puts "PASV"
+          @client.gets.should == "502 Aww hell no, use Active\r\n"
+        end
+
+        it "does not accept PORT (yet)" do
+          ## TODO this test can go away once the following pending test succeeds
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets
+          @client.puts "PORT 127,0,0,1,82,224"
+          @client.gets.should == "500 Not implemented yet\r\n"
+        end
+
+        xit "accepts PORT and connects to port" do
+          # @testing = true
+          # @data_server = ::TCPServer.new('127.0.0.1', 21216)
+          # @data_connection = Thread.new do
+          #   while @testing
+          #     @server_client = @data_connection.accept
+          #     @server_connection = Thread.new(@server_client) do |socket|
+          #       @connected = true
+          #     end
+          #   end
+          # end
+          # @client.gets
+          # @client.puts "PORT 127,0,0,1,82,224"
+          # @client.gets.should == "200 Okay\r\n"
+          # @connected.should be_true
+          # @testing = false
+        end
+      end
+
+      context 'authentication commands' do
+        before :each do
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets ## connection successful response
+        end
+
+        after :each do
+          @client.close
+        end
+
+        it "accepts USER" do
+          @client.puts "USER some_dude"
+          @client.gets.should == "331 send your password\r\n"
+        end
+
+        it "accepts anonymous USER" do
+          @client.puts "USER anonymous"
+          @client.gets.should == "230 logged in\r\n"
+        end
+
+        it "accepts PASS" do
+          @client.puts "PASS password"
+          @client.gets.should == "230 logged in\r\n"
+        end
+
+        it "accepts ACCT" do
+          @client.puts "ACCT"
+          @client.gets.should == "230 WHATEVER!\r\n"
+        end
+      end
+
+      context 'directory commands' do
+        before :each do
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets ## connection successful response
+        end
+
+        after :each do
+          @client.close
+        end
+
+        it "returns directory on PWD" do
+          @server.directory = @directory
+          @client.puts "PWD"
+          @client.gets.should == "257 \"#{@directory}\" is current directory\r\n"
+        end
+
+        it "returns default directory on PWD" do
+          @server.directory = '/tmp'
+          @client.puts "PWD"
+          @client.gets.should == "257 \"/tmp\" is current directory\r\n"
+        end
+
+        it "says OK to any CWD, CDUP, without doing anything" do
+          directory = @server.directory
+          @client.puts "CWD somewhere/else"
+          @client.gets.should == "250 OK!\r\n"
+          @server.directory.should == directory
+          @client.puts "CDUP"
+          @client.gets.should == "250 OK!\r\n"
+          @server.directory.should == directory
+        end
+
+        it "does not respond to MKD" do
+          @client.puts "MKD some_dir"
+          @client.gets.should == "500 Unknown command\r\n"
+        end
+      end
+
+      context 'file commands' do
+        before :each do
+          @client = TCPSocket.open('127.0.0.1', 21212)
+          @client.gets ## connection successful response
+        end
+
+        after :each do
+          @client.close
+        end
+
+        it "accepts TYPE ascii" do
+          @client.puts "TYPE A"
+          @client.gets.should == "200 Type set to A.\r\n"
+        end
+
+        it "accepts TYPE image" do
+          @client.puts "TYPE I"
+          @client.gets.should == "200 Type set to I.\r\n"
+        end
+
+        it "does not accept TYPEs other than ascii or image" do
+          @client.puts "TYPE E"
+          @client.gets.should == "504 We don't allow those\r\n"
+          @client.puts "TYPE N"
+          @client.gets.should == "504 We don't allow those\r\n"
+          @client.puts "TYPE T"
+          @client.gets.should == "504 We don't allow those\r\n"
+          @client.puts "TYPE C"
+          @client.gets.should == "504 We don't allow those\r\n"
+          @client.puts "TYPE L"
+          @client.gets.should == "504 We don't allow those\r\n"
+        end
+
+        it "accepts STOR with filename" do
+          @client.puts "STOR some_file"
+          @client.gets.should == "125 Do it!\r\n"
+          @data_client = TCPSocket.open('127.0.0.1', 21213)
+          @data_client.puts "1234567890"
+          @data_client.close
+          @client.gets.should == "226 Did it!\r\n"
+          @server.files.should include('some_file')
+        end
+      end
+    end
+
+    context 'ftp client' do
+      before :each do
+        @ftp = Net::FTP.new
+      end
+      it 'should accept ftp connections' do
+        proc { @ftp.connect('127.0.0.1', 21212) }.should_not raise_error
+        proc { @ftp.close }.should_not raise_error
+      end
+
+      it "should allow anonymous authentication" do
+        @ftp.connect('127.0.0.1', 21212)
+        proc { @ftp.login }.should_not raise_error
+        @ftp.close
+      end
+
+      it "should allow named authentication" do
+        @ftp.connect('127.0.0.1', 21212)
+        proc { @ftp.login('someone', 'password') }.should_not raise_error
+        @ftp.close
+      end
+
+      it "should allow client to quit" do
+        @ftp.connect('127.0.0.1', 21212)
+        proc { @ftp.login('someone', 'password') }.should_not raise_error
+        proc { @ftp.quit }.should_not raise_error
+        @ftp.close
+      end
+
+      it "should put files to directory store using PASV" do
+        @ftp.connect('127.0.0.1', 21212)
+        @ftp.passive = true
+        proc { @ftp.put(@text_filename) }.should_not raise_error
+        @server.files.should include('text_file.txt')
+      end
+
+      xit "should disconnect clients on close" do
+        # TODO: when this succeeds, we can care less about manually closing clients
+        #       otherwise we get a CLOSE_WAIT process hanging around that blocks our port
+        @ftp.connect('127.0.0.1', 21212)
+        @server.stop
+        @ftp.closed?.should be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.dirname(__FILE__), '**','*')
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'fake_ftp' # and any other gems you need
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: fake_ftp
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Colin Shield
+- Eric Saxby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id003
+description: Testing FTP? Use this!
+email: 
+- sax+github@livinginthepast.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- fake_ftp.gemspec
+- lib/fake_ftp.rb
+- lib/fake_ftp/server.rb
+- lib/fake_ftp/version.rb
+- spec/fixtures/invisible_bike.jpg
+- spec/fixtures/text_file.txt
+- spec/models/fake_ftp/server_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/fake_ftp
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: fake_ftp
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Creates a fake FTP server for use in testing
+test_files: 
+- spec/fixtures/invisible_bike.jpg
+- spec/fixtures/text_file.txt
+- spec/models/fake_ftp/server_spec.rb
+- spec/spec_helper.rb