test_server 0.4.1 → 0.5.0

data/lib/test_server/checksum_calculator.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module TestServer
+  class ChecksumCalculator
+    private
+
+    attr_reader :engine
+
+    public
+
+    def use(file)
+      file.checksum = compute_checksum(file)
+    rescue StandardError => err
+      Rails.logger.error "#{err.class}: #{err.message}"
+      
+      checksum = OpenStruct.new
+      checksum.value = "An error occured while determine checksum for \"#{file.name}\"."
+
+      file.checksum = checksum
+    end
+
+    private
+
+    def compute_checksum(file)
+      raise MethodNotImplemented, JSON.dump(method: :compute_checksum)
+    end
+  end
+end

data/lib/test_server/command_runner.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require 'timeout'
+require 'ostruct'
+
+module TestServer
+  class CommandRunner
+
+    private
+
+    attr_reader :timeout
+
+    public
+
+    def initialize(timeout:)
+      @timeout = timeout
+    end
+
+    def run(command)
+      # stdout, stderr pipes
+      rout, wout = IO.pipe
+      rerr, werr = IO.pipe
+
+      result = OpenStruct.new
+
+      begin
+        result.pid = Process.spawn(command, :out => wout, :err => werr)
+        _, status = Timeout::timeout(timeout) { Process.wait2(result.pid) }
+
+        result.status = status.exitstatus
+      rescue Timeout::Error
+        Process.kill 'KILL', result.pid
+        result.status = 99
+      end
+
+      # close write ends so we could read them
+      wout.close
+      werr.close
+
+      result.stdout = rout.readlines
+      result.stderr = rerr.readlines
+
+      # dispose the read ends of the pipes
+      rout.close
+      rerr.close
+
+      result
+    end
+  end
+end
+
+module TestServer
+  module RunCommand
+    def run_command(command, timeout: 5)
+      runner = CommandRunner.new(timeout: timeout)
+      runner.run(command)
+    end
+  end
+end

data/lib/test_server/exceptions.rb

@@ -41,5 +41,8 @@ module TestServer
 
     # raised if developer misses to define action for controller in parameter list
     class ActionNotDefinedInParameterList < InternalError; end
+
+    # raised if developer misses to define role
+    class RoleNotDefined < InternalError; end
   end
 end

data/lib/test_server/file_size.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+class FileSize
+  attr_accessor :value, :suffix
+
+  def initialize(value:, suffix:)
+    @value = value
+    @suffix = suffix
+  end
+
+  def to_s
+    "#{value} #{suffix}"
+  end
+end

data/lib/test_server/filetype_detector.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module TestServer
+  class FiletypeDetector
+    private
+
+    attr_reader :engine
+
+    public
+
+    def initialize(engine: FileMagic.new)
+      @engine = engine
+    end
+
+    def use(file)
+      file.filetype = engine.file(file.path)
+    rescue StandardError => err
+      Rails.logger.error "#{err.class}: #{err.message}"
+      file.filetype = "An error occured while determine file type for \"#{file.name}\"."
+    end
+  end
+end

data/lib/test_server/locales/en.yml

@@ -49,6 +49,7 @@ en:
         reset: 'Reset'
         close: 'Close'
         clone: 'Clone'
+        upload: 'Upload'
     dialogs:
       notification:
         title: Notification
@@ -105,6 +106,33 @@ en:
       index:
         title: Overview for Reflectors
         link: Overview
+    file_uploader:
+      title: File Uploader
+      link: File Uploader
+      index:
+        title: Overview for File Uploads
+        link: Overview
+      result:
+        title: "Information about %{file}"
+        link: "%{file}"
+        fields:
+          file: File
+          checksum: Checksums
+          filename: Filename
+          virus: Virus ID
+          filetype: Filetype
+          size: Size
+      upload:
+        title: Upload file
+        link: Upload file
+        fields:
+          file: File
+          virus_scan: Scan for viruses
+          filetype_detection: Detect filetype
+          checksum_calculation: Calculate Checksums
+        spinner: 
+          text: Waiting for upload to finish...
+
     static:
       link: Static
       title: Static content
@@ -134,4 +162,3 @@ en:
           status: Status
         spinner: 
           text: Waiting for results...
-

data/lib/test_server/main.rb

@@ -14,7 +14,12 @@ module TestServer
       TestServer.ui_logger.info "Activating debug mode."
 
       require 'pry'
-      require 'debugger'
+      if RUBY_VERSION < '2.0.0'
+        require 'debugger'
+      else
+        require 'byebug'
+      end
+
     rescue LoadError
       TestServer.ui_logger.error "You tried to enable debug-mode, but either 'pry'- or 'debugger'-gem are not installed. Please fix that before using the debug-switch again."
     end

data/lib/test_server/md5_calculator.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module TestServer
+  class MD5Calculator < ChecksumCalculator
+    private
+
+    attr_reader :engine
+
+    def compute_checksum(file)
+      Checksum.new(
+        algorithm: :md5,
+        prefix: 'MD5',
+        engine: Digest::MD5,
+        data: File.read(file.path),
+      )
+    end
+  end
+end

data/lib/test_server/permitted_params.rb

@@ -13,7 +13,9 @@ module TestServer
       @params = params
 
       @database = {
+        # controller name
         dashboard: {
+          # action: role1, role2, ...
           show: [],
         },
         reflector: {
@@ -40,6 +42,11 @@ module TestServer
           xhr: [:generatable, :repeatable],
           index: [],
         },
+        file_uploader: {
+          upload: [],
+          result: [:uploadable],
+          index: [],
+        },
       }
     end
 
@@ -47,8 +54,8 @@ module TestServer
       name   = name.to_sym
       action = action.to_sym
 
-      raise Exceptions::ControllerNotDefinedInParameterList unless database.key? name
-      raise Exceptions::ActionNotDefinedInParameterList     unless database[name].key? action
+      raise Exceptions::ControllerNotDefinedInParameterList, JSON.dump(name: name) unless database.key? name
+      raise Exceptions::ActionNotDefinedInParameterList, JSON.dump(action: action) unless database[name].key? action
 
       generate_params(defaults, params_for(database[name][action]))
     end
@@ -65,15 +72,22 @@ module TestServer
 
     private
 
+    def validate_role(role)
+      raise Exceptions::RoleNotDefined, JSON.dump(role: role, required_method: :"#{role}_params") unless self.respond_to? :"#{role}_params", true
+    end
+
+    def determine_attributes(role)
+      send :"#{role}_params"
+    end
+
     def params_for(*roles)
       roles    = roles.flatten
       attributes = Set.new
 
-      attributes = attributes + countable_params   if roles.include? :countable
-      attributes = attributes + encodable_params   if roles.include? :encodable
-      attributes = attributes + cachable_params    if roles.include? :cachable
-      attributes = attributes + repeatable_params  if roles.include? :repeatable
-      attributes = attributes + generatable_params if roles.include? :generatable
+      roles.each do |r|
+        validate_role r
+        attributes += determine_attributes(r)
+      end
 
       attributes
     end
@@ -107,5 +121,9 @@ module TestServer
     def cachable_params
       [:expires]
     end
+
+    def uploadable_params
+      [:authenticity_token, :file, :upload, { test_server_file_upload: [ :uploaded_file, :virus_scan, :filetype_detection, :checksum_calculation ] }, :utf8]
+    end
   end
 end

data/lib/test_server/sha256_calculator.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module TestServer
+  class Sha256Calculator < ChecksumCalculator
+    private
+
+    attr_reader :engine
+
+    def compute_checksum(file)
+      Checksum.new(
+        algorithm: :sha256,
+        prefix: 'SHA256',
+        engine: Digest::SHA256,
+        data: File.read(file.path),
+      )
+    end
+  end
+end

data/lib/test_server/uploaded_file.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module TestServer
+  class UploadedFile
+    private
+
+    attr_reader :uploaded_file
+
+    public
+
+    attr_accessor :filetype, :virus_id, :checksum
+
+    def initialize(uploaded_file)
+      if uploaded_file.respond_to? :tempfile
+        @uploaded_file = uploaded_file
+      else
+        @uploaded_file = OpenStruct.new
+      end
+
+      @checksum = []
+    end
+
+    def checksum=(sum)
+      @checksum << sum
+    end
+
+    def path
+      uploaded_file.path.to_s
+    end
+
+    def name
+      File.basename(uploaded_file.original_filename.to_s)
+    end
+
+    def has_filetype?
+      !filetype.blank?
+    end
+
+    def contains_virus?
+      !virus_id.blank?
+    end
+
+    def has_checksum?
+      !checksum.blank?
+    end
+
+    def size
+      formula = lambda { |number| uploaded_file.size.to_f  / (2**number) }
+
+      result = {}
+      result[:b] = FileSize.new(suffix: 'B', value: uploaded_file.size.to_s)
+      result[:kib] = FileSize.new(suffix: 'KiB', value: '%.2f' % formula.call(10))
+      result[:mib] = FileSize.new(suffix: 'MiB', value: '%.2f' % formula.call(20))
+      result[:gib] = FileSize.new(suffix: 'KiB', value: '%.2f' % formula.call(30))
+
+      result
+    end
+  end
+end

data/lib/test_server/version.rb

@@ -1,4 +1,4 @@
 #main TestServer
 module TestServer
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/test_server/virus_detector.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module TestServer
+  class VirusDetector
+
+    private
+
+    attr_reader :command, :timeout
+
+    public
+
+    def initialize(command: which('clamdscan'))
+      @command = command
+      @timeout = 60
+    end
+
+    def use(file)
+      file.virus_id = scan(file)
+    end
+
+    private
+
+    include FeduxOrg::Stdlib::Command::Which
+    include TestServer::RunCommand
+
+    def scan(file)
+      return "Scan commands \"clamdscan\" and \"clamscan\" not found. File \"#{file.name}\" could not be scanned." if command.blank?
+
+      result = run_command("#{command} #{file.path}", timeout: timeout)
+      return "Timeout \"#{timeout}\" reached before finishing scan." if result.status == 99
+      return "Scan failed due to error: #{extract_error(result.stdout)}" if result.stdout.first['ERROR']
+
+      extract_virus_id(result.stdout)
+    end
+
+    def extract_error(data)
+      data.first.chomp.split(/:/).last
+    end
+
+    def extract_virus_id(data)
+      data.first.scan(/^[^:]+:\s([[:alnum:]-]+)\s[[:alpha:]]+/).flatten.first
+    end
+  end
+end

data/lib/test_server.rb

@@ -17,6 +17,9 @@ require 'base64'
 require 'thor'
 require 'zlib'
 require 'digest/sha1'
+require 'timeout'
+require 'filemagic'
+require 'securerandom'
 
 require 'active_support/core_ext/kernel/reporting'
 require 'active_support/core_ext/object/blank'
@@ -24,6 +27,8 @@ require 'active_support/core_ext/array/access'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/string/inflections'
 
+require 'fedux_org/stdlib/command/which'
+
 require 'timeout'
 require 'logger'
 require 'pager'
@@ -68,6 +73,16 @@ require 'test_server/server_commands/puma'
 require 'test_server/server_commands/rackup'
 require 'test_server/server'
 
+require 'test_server/command_runner'
+require 'test_server/file_size'
+require 'test_server/uploaded_file'
+require 'test_server/virus_detector'
+require 'test_server/filetype_detector'
+require 'test_server/checksum'
+require 'test_server/checksum_calculator'
+require 'test_server/sha256_calculator'
+require 'test_server/md5_calculator'
+
 require 'test_server/cli/helper'
 require 'test_server/cli/reload'
 require 'test_server/cli/main'