abuse-the-force/lib/abusetheforce/cli.rb

require 'thor'
require 'highline/import'
require 'abusetheforce/xmltemplates'
require 'abusetheforce/version'

module AbuseTheForce

    TEMP_DIR=".atf_tmp"
    RESOURCE_DIR="resources"

    # MODULE METHODS

    # Toggle to a new target temporarily
    def self.temp_switch_target(name=nil)
        # If a name was provided, switch to that
        if name != nil
            # Store the original target's name
            @last_target = Atf_Config.active_target.name
            # Switch to the new target
            Atf_Config.set_active_target name
        else
            # Switch back to the old target
            Atf_Config.set_active_target @last_target
        end
    end

    # Safe prompt for password
    def self.get_password(prompt="Enter Password: ")
       ask(prompt) {|q| q.echo = false}
    end

    # Cleans out the temp directory for further deployments
    def self.clean_temp

        # Get path to temp project directory
        temp_path = File.join(Atf_Config.root_dir, TEMP_DIR)

        # Clear temp dir
        if Dir.exists? temp_path
            FileUtils.rm_r temp_path
        end

    end

    # Builds temp path
    def self.build_temp

        # Get path to temp project directory
        temp_path = File.join(Atf_Config.root_dir, TEMP_DIR)

        # If a temp dir exists, clear it
        if Dir.exists? temp_path
            self.clean_temp
        end

        # Make the directory
        FileUtils.mkdir_p temp_path

        # Copy the package file
        FileUtils.copy(
            File.join(Atf_Config.get_project_path, 'package.xml'),
            File.join(temp_path, 'package.xml')
        )

    end

    # Copy file to temp directory
    def self.copy_temp_file(fpath)

        # Make the filepath absolute
        fpath = File.absolute_path fpath
        abs_root = File.absolute_path Atf_Config.root_dir

        # Check that file path is in root dir
        unless fpath.starts_with? abs_root
            pute("File does not exist within root project: #{fpath}")

            return false
        end

        # Check if a resource
        if fpath.starts_with? File.join(abs_root, RESOURCE_DIR)
            # This is a resource file
            # Zip the resource up and then deploy new fpath

            resource_path = File.dirname fpath

            # Until we find the parent directory of the current location is the root resource dir
            until File.dirname(resource_path) == File.join(abs_root, RESOURCE_DIR)
                # Go up to the next parent
                resource_path = File.dirname resource_path
            end

            # Set the fpath to the new zip file
            fpath = AbuseTheForce.zip_resource resource_path
        end

        # Make sure file is in project path
        unless fpath.starts_with? Atf_Config.get_project_path
            pute("File does not exist within root project: #{fpath}")
            return false
        end

        # Get path to temp project directory
        temp_path = File.join(Atf_Config.root_dir, TEMP_DIR)

        # If temp dir doesn't exist make it
        unless Dir.exists? temp_path
            self.build_temp
        end

        # Get the metadata directory right before filename
        mdir = File.basename(File.dirname(fpath))

        # Create the temp directories
        FileUtils.mkdir_p File.join(temp_path, mdir)

        # Copy the file
        if File.exists? fpath
            FileUtils.copy(
                File.join(fpath),
                File.join(temp_path, mdir, '/')
            )
        else
            pute("File not found...")
            return false
        end

        # Copy the metadata
        if File.exists? fpath + '-meta.xml'
            FileUtils.copy(
                File.join(fpath + '-meta.xml'),
                File.join(temp_path, mdir, '/')
            )
        end

        return true
    end

    def self.zip_resource(resource_path)
        resource_name = File.basename resource_path

        zip_path = File.join(Atf_Config.get_project_path, 'staticresources', resource_name + '.resource')

        # Compress the resource
        `cd $(dirname "#{resource_path}") && zip -Xr #{zip_path} #{resource_name}`

        # Write the meta.xml
        File.open(zip_path + '-meta.xml', 'w') {|f| f.write(XML_STATIC_RESOURCE) }

        return zip_path
    end

    class TargetCLI < Thor

        desc "add <alias> <username> <security token> [--sandbox]", "Adds a new remote target"
        long_desc <<-LONG_DESC
            Adds a new target org with the alias <alias> to your atf.yaml file
            with the provided <username>, <security token> and prompted password.

            With -s or --sandbox option, sets host to "test.salesforce.com"

            To perform any actions you must have a valid target added
        LONG_DESC
        option :sandbox, :type => :boolean, :aliases => :s, :default => false
        def add(name, username, security_token)
            password = AbuseTheForce.get_password
            host = (options[:sandbox] ? "test.salesforce.com" : "login.salesforce.com")

            # Add the target to the config
            Atf_Config.add_target(Atf_Target.new(name, username, password, security_token, host))
        end

        desc "update <alias> [--password | --sandbox=<true/false> | --token=<token>]", "Updates a remote target"
        long_desc <<-LONG_DESC
            Updates a part of target with <alias>

            -p or --password option, prompts you for an updated password

            -s or --sandbox <true/false> option, switches the host to sandbox or production

            --token=<security token> option, sets the security token to the value provided

            The changes will then be written to the .abusetheforce.yaml file
        LONG_DESC
        option :password, :type => :boolean, :aliases => :p, :default => false, :desc => "Prompt for password"
        option :token, :banner => "<security token>"
        option :sandbox, :type => :boolean, :aliases => :s, :desc => "Add this if deploying to a sandbox"
        def update(name)

            target = Atf_Config.targets[name]

            if target != nil
                if options[:password]
                    target.set_password AbuseTheForce.get_password
                end
                if options[:token] != nil
                    target.security_token = options[:token]
                end
                if options[:sandbox] != nil
                    target.host = (options[:sandbox] ? "test.salesforce.com" : "login.salesforce.com")
                end
            else
                AbuseTheForce.pute("Target not found", true)
            end

            # Save to yaml
            Atf_Config.dump_settings
        end

        desc "remove <alias>", "Removes a remote target"
        def remove(name)
            Atf_Config.targets.delete name
            # Save to yaml
            Atf_Config.dump_settings
        end

        desc "activate <alias>", "Activates specified target"
        long_desc <<-LONG_DESC
            Activates the target specified by <alias>.

            You must have an active target to perform any actions
        LONG_DESC
        def activate(name)
            # Activate the target
            Atf_Config.set_active_target name
        end

        desc "current", "Shows currently active target"
        def current()

            if Atf_Config.active_target != nil
                Atf_Config.active_target.print
            else
                AbuseTheForce.putw "No active target set"
            end
        end

        desc "list", "Lists all targets"
        def list()
            target_output = []

            target_output.push ["Active", "Alias", "Username", ""]

            Atf_Config.targets.values.each do |target|
                #target.print

                target_output.push ["#{(target.active ? '  ==> ' : ' ')}",
                                    target.name,
                                    target.username,
                                    "#{(target.host.starts_with?('test') ? 'sandbox' : '')}"
                ]
            end

            print_table target_output

        end

        # By default, display the current target
        default_task :current
    end

    class DeployCLI < Thor
        class_option :target, :banner => "<target alias>", :aliases => :t
        #class_option :delete, :aliases => :d

        desc "file <path to file>", "Deploy a single file"
        long_desc <<-LONG_DESC
            Deploys file at path <path to file> to the active target.
        LONG_DESC
        def file(fpath)

            AbuseTheForce.clean_temp

            AbuseTheForce.copy_temp_file fpath

            # If a new target was provided, switch to it
            if options[:target] != nil
                AbuseTheForce.temp_switch_target options[:target]
            end

            # Get path to temp project directory
            temp_path = File.join(Atf_Config.root_dir, TEMP_DIR)

            # Deploy
            AbuseTheForce.deploy_project temp_path

            # if using a temp target, switch back
            if options[:target] != nil
                AbuseTheForce.temp_switch_target
            end

            # We're done, so clean the path
            AbuseTheForce.clean_temp
        end

        desc "test <path to file>", "Deploy and execute a test class"
        long_desc <<-LONG_DESC
            Deploys file at path <path to file> to the active target and executes tests in that class.

            If test fails changes are rolled back
        LONG_DESC
        def test(fpath)

            AbuseTheForce.clean_temp

            AbuseTheForce.copy_temp_file fpath

            # If a new target was provided, switch to it
            if options[:target] != nil
                AbuseTheForce.temp_switch_target options[:target]
            end

            # Get path to temp project directory
            temp_path = File.join(Atf_Config.root_dir, TEMP_DIR)

            test_name = File.basename fpath, '.*'

            # Deploy
            AbuseTheForce.deploy_test temp_path, test_name

            # if using a temp target, switch back
            if options[:target] != nil
                AbuseTheForce.temp_switch_target
            end

            # We're done, so clean the path
            AbuseTheForce.clean_temp
        end

        desc "list <path to list>", "Deploy a list of files"
        long_desc <<-LONG_DESC
            Parameter is a path a file containing a realtive list of files to be deployed.

            This can be handily used with git diff
        LONG_DESC
        def list(list_path)

            # Check that this file exists
            unless File.file? list_path
                AbuseTheForce.pute("List not found", true)
            end

            # Clean out the temp directory
            AbuseTheForce.clean_temp

            have_files = false

            # Go through each line of the file
            IO.readlines(list_path).each do |fpath|

                # have to strip off newlines
                fpath = File.absolute_path fpath.chomp

                # Check that file exists
                if File.file? fpath

                    # If this line is just a meta file, skip it
                    if fpath.ends_with? 'meta.xml'
                        next
                    end

                    # Did the file copy?
                    file_copied = AbuseTheForce.copy_temp_file fpath

                    # Display something to the user to know what files are copied
                    if file_copied
                        puts "Deploying #{fpath}"
                    end

                    # Keep track of if we have any successfullly coppied files
                    have_files = (have_files || file_copied)

                else
                    # If we can't find the item warn the user
                    AbuseTheForce.putw "File not found: #{fpath}"
                end

            end

            if have_files
                # Get path to temp project directory
                temp_path = File.join(Atf_Config.root_dir, TEMP_DIR)

                # If a new target was provided, switch to it
                if options[:target] != nil
                    AbuseTheForce.temp_switch_target options[:target]
                end

                # Deploy the path
                AbuseTheForce.deploy_project temp_path

                # if using a temp target, switch back
                if options[:target] != nil
                    AbuseTheForce.temp_switch_target
                end
            end

            # We're done, so clean the path
            AbuseTheForce.clean_temp
        end

        desc "project", "Deploy a whole project"
        def project(target=nil)

            # If a new target was provided, switch to it
            if options[:target] != nil
                target = options[:target]
            end
            if target != nil
                AbuseTheForce.temp_switch_target target
            end

            # Directory that holds resources
            resource_dir = File.join(Atf_Config.root_dir, RESOURCE_DIR)

            if File.directory? resource_dir
                puts "Resources found, zipping"

                # Get an array of all directories in the resource dir
                resources = Dir.glob(File.join(resource_dir, '*')).select {|f| File.directory? f}

                # Zip each resource
                resources.each do |resource_path|
                    AbuseTheForce.zip_resource resource_path
                end
            end

            # Deploy the project
            AbuseTheForce.deploy_project

            # if using a temp target, switch back
            if target != nil
                AbuseTheForce.temp_switch_target
            end
        end
    end

    class RetrieveCLI < Thor
        class_option :target, :banner => "<target alias>", :aliases => :t
        #class_option :delete, :aliases => :d

        desc "file <file> [metadata type]", "Retrieve a single file"
        long_desc <<-LONG_DESC
            Retrieves one file from the active target

            This has two uses:

            To retrieve a file not on the local machine, provide the name of the
            file and the metadata type.

            Example: $atf retrieve file MyClassName ApexClass

            To retrieve a new version of a file already local to you, you just
            provide the path to the file.

            Example: $atf retrieve file ./src/classes/MyClass

            NOTE: Must be called from the root project directory
        LONG_DESC
        def file(full_name, metadata_type=nil)
            # TODO: Work backwards if called not in child of project directory

            # If a new target was provided, switch to it
            if options[:target] != nil
                AbuseTheForce.temp_switch_target options[:target]
            end

            # No metadata passed in, this should be a file path
            if metadata_type == nil
                if File.file? full_name
                    # Get the file extension
                    extname = File.extname full_name
                    # Get the base name of the metadata
                    full_name = File.basename(full_name, extname)

                    # Detect metadata type by file extension
                    case extname
                    when '.cls'
                        metadata_type = 'ApexClass'
                    when '.trigger'
                        metadata_type = 'ApexTrigger'
                    when '.object'
                        metadata_type = 'CustomObject'
                    when '.page'
                        metadata_type = 'ApexPage'
                    when '.component'
                        metadata_type = 'ApexComponent'
                    else
                        AbuseTheForce.pute('Unrecognized file type', true)
                    end
                end
            end

            # retrieve the file using metaforce
            AbuseTheForce.retrieve_file(metadata_type, full_name)

            # if using a temp target, switch back
            if options[:target] != nil
                AbuseTheForce.temp_switch_target
            end
        end

        desc "project", "Retrieve a whole project"
        def project(target=nil)

            # If a new target was provided, switch to it
            if options[:target] != nil
                target = options[:target]
            end
            if target != nil
                AbuseTheForce.temp_switch_target target
            end

            # Retrieve the project
            AbuseTheForce.retrieve_project

            # if using a temp target, switch back
            if target != nil
                AbuseTheForce.temp_switch_target
            end
        end
    end

    # AbUse The Force
    class AtfCLI < Thor

        # Load the abuse-the-force config
        Atf_Config.load

        # ATF Subcommands
        desc "target SUBCOMMAND ...ARGS", "Manage deploy targets"
        subcommand "target", TargetCLI

        desc "deploy SUBCOMMAND ...ARGS", "Deploy code to Salesforce.com"
        subcommand "deploy", DeployCLI

        desc "retrieve SUBCOMMAND ...ARGS", "Retrieve code from Salesforce.com"
        subcommand "retrieve", RetrieveCLI

        desc "version", "Version information"
        def version
            puts "version #{AbuseTheForce::VERSION}"
        end

    end

end # end module AbuseTheForce