solenopsis/solenopsis

A deployment tool for Salesforce

Solenopsis

Solenopsis is a tool born out of necessity. With no good command-line tool to deploy Salesforce code with it was written to meet a need. Solenopsis is a combination of some ANT scripts to do deployment and Python scripts to do easily manage flags and other neat things like templates.

Right now, all testing and development has been focused on Linux. But patches are welcome to make it truely multi-platform.

Dependencies

• Python
• Ant
• Python Beatbox (optional)

Libraries

These are the libraries used in Solenopsis. Just a list for them being awesome (and some legal reasons too).

Ant

• ant
• ant-contrib
• ant-unit
• beanshell
• ivy
• JGit

Licenses and additional information can be found in the docs directory.

Python

• beatbox (optional)

Getting Started

• Read about Solenopsis
• Install Solenopsis
• Get Support

Getting Started With v1.1

• Configure Solenopsis
• Use Solenopsis
• Install Solenopsis

NOTE: Currently this project has only been developed and tested on Linux. Patches and help for other platforms are always accepted.

solenopsis's Issues

When performing destructive-pushes, if the last filter is deleted it breaks

Need to figure out a way around this.

Generate package.xml based upon file contains

Would be nice to generate a package.xml based upon file containing some string.

If no master is specified, look at current working dir to see what env is being used

If no master is defined, it'd be nice to extrapolate what the current working directory is and if its within one of the environments - use it as master.

New git-status work fails under Fedora

Looks like git-status is broken under Fedora

Chunk into 400mb pulls

I know this is the longest of the long shots, but any possibility in the future of being able to pull from orgs that hit the 400mb metadata API limit by chunking the pulls out?

The error just in case :)

/usr/share/solenopsis/ant/util/sfdc-util.xml:613: Failed to process the request successfully. Cause(LIMIT_EXCEEDED): LIMIT_EXCEEDED: The retrieved zip file exceeded the limit of 419430400 bytes.

All reports do not get packages correctly on a file push and the name element in package.xml is missing data

If you attempt to push a report, the package.xml is wrong and the report may not get pushed. The package.xml looks like (using square brackets vs angle):

[package xmlns="http://soap.sforce.com/2006/04/metadata"]
[types]
[members]*[/members]
[name][/name]
[/types]
[version]26.0[/version]
[/package]

Also, the deploy.zip has this as its contents:

Archive: /tmp/sfloess/solenopsis/file-push/deploy.zip
Length Date Time Name

---

  173  02-08-2013 09:37   package.xml

---

  173                     1 file

Document generateTests

Need to document generateTests:

• solenopsis.properties
  • sf.generateTests
• env credentials file

Provide ability to generate a package.xml for modification

Need a task to generate a package.xml on demand (for manual modification).

Enhance XML building

There is currently no way to use arbitrary attributes. We definitely need this in sfdcutil:runTests where we build the tests to run. Its sorta kludgy right now.

Add ability to run specified tests

Document bsolenopsis

When working on issue #48, we included a new shell script for kicking off the Ant script. It calls Ant as a Java app and really only supports Ant based command line arguments.

This needs to be documented in the wiki.

Provide a script to install on a *nix platform outside RPM

Just like the RPM is doing, provide a script to do likewise on a *nix platform.

destructive-push

Even when using an ignore file to ignore UserLicense.workflow this is the generated destructiveChanges.xml destructiveChanges - https://gist.github.com/2481039

All sf.[property] should be supported in credentials files

Make sure one define sf.[property] based versions in all credentials files...

Ensure EmailTemplates can be retrieved with the metadata API

Stop using solenopsis.ENVIRONMENT

There is really no reason to use anything contained in solenopsis.ENVIRONMENT. We can extrapolate environments from whats contained in solenopsis credentials home...

jdk/ant version issue?

I am not sure, but I got following when destructive-push.

/usr/share/solenopsis/ant/solenopsis.xml:206: The following error occurred while executing this line:
/usr/share/solenopsis/ant/util/sfdc-util.xml:822: Failed to login: Failed to parse detail: START_TAG seen ...<sf:LoginFault xsi:type="sf:LoginFault">... @1:434 due to: com.sforce.ws.ConnectionException: Incompatible type 'class com.sforce.soap.partner.fault.LoginFault' specified as xsi:type. It must be a subclass of 'class com.sforce.ws.ConnectionException'

Please note:
$ java -version
java version "1.6.0_38"
Java(TM) SE Runtime Environment (build 1.6.0_38-b05)
Java HotSpot(TM) 64-Bit Server VM (build 20.13-b02, mixed mode)

$ ant -version
Apache Ant(TM) version 1.8.3 compiled on February 29 2012

Convert ~ in dir properties to the value for the system property user.home

If someone mistakenly uses ~ in as part of a directory name (in a property), the ~ is not expanded internally by Ant.

This needs to be changed to change the ~ to whatever the value of the system property is for user.home.

Store files copied in a property for copyFiles macrodef

The copyFiles macrodef should allow for the copied files to be added to a property that is handed in on call.

Look into supporting managed packages

Need to be able to support managed packages.

Ability to conduct a text search to generate a package.xml

Occasionally a full diff isn't needed but a search for specific text string, usually a ticket number added in code comments/description of fields. Would be good if a text search could be made and a package.xml generated with the results. This would allow for smaller portions of work to be moved. Useful if 2 people are working separate issues.

Allow for selective pull just like push

We should be able to selective pull files/folders from an environment. Similar to what we do with file-push's

Ensure Solenopsis works in Windows

Try out:

• XP
• Vista
• Windows 8

Need command line processing for generating packages

Added two new targets to solenopsis.xml:

• generate-package
  • -Dsf.packageDir - directory to generate a non-folder based package. Is optional and if not set defaults to the current working dir.
  • -Dsf.version - the API version in package.xml. Is optional and will default to the one denoted in sfdc.metadata.properties.
• generate-full-package
  • -Dsolenopsis.env.MASTER - the master env to use. Is optional and if not set, defaults to whatever is in ~/solenopsis.properties.
  • -Dsf.packageDir - directory to generate a non-folder based package. Its optional and if not set defaults to the current working dir.
  • -Dsf.version - the API version in package.xml. Is optional and will default to the one denoted in sfdc.metadata.properties.

Document generate package.xml (both folder and non-folder)

Need documentation for how to generate package.xml for both folder and non-folder based operations.

Allow manual package.xml for deploys/pulls

Currently package.xml is autogenerated. We should allow for a manual one to be provided for deploys/pulls.

Consider using JGit for Git managements

Currently shelling to the OS for Git modifieds/adds/deleteds.

This is great for Linux but not necessarily for the OSes.

Need better way to denote SOLENOPSIS_GIT_OS_SHELL

We should honor the environment variable. However, would be nice to express in ~/solenopsis.properties. For example as sf.gitOsShell or something like it.

Run tests does not work to de's

For some reason sandboxes work when we run test, but de's do not.

Add ability to run specified tests

It would be nice to run a given test class or set of classes from the command-line.

Document the log types

We've denoted the log types, but also denote them in a place like a Tips-And-Tricks page.

Document cached-destructive-push

Need to document cached-destructive-push and how when a pull happens from an env, its copied to [solenopsis.env.HOME]/[env].

Document invalid login issues when there is a bad token

When there is a bad token, we get what looks akin to a class cast exception. Need to document this in the wiki and how to work around the issue.

Set env first, then call solenopsis.properties

In solenopsis-setup.xml, we set properties from solenopsis.properties first then from the environment. We really should set properties from the environment, then from solenopsis.properties.

Ampersands and Dollar signs in credentials breaks things

When there is an ampersand/dollar sign in our credentials it will break upon deploy.

Change rh-util:replaceVariables to use Ant 1.7.1+ regexp

Once issue #48 is completed, we can move over to Ant 1.7.1+ regular expressions. This is found in rh-util:replaceVariables macrodef with the following comment:

ONLY GOOD IN ANT 1.7.1+!!!

On some platforms, git-status is breaking

Looks like JGit is not being found (in the git-status scriptdef). Need to be able to turn on shelling into the OS for git status.

Need to make filesContains be its own push type

Currently, we overload file-push to also include fileContains. Although this works, it makes the file-push macrodef more convoluted.

It should really be its own push type like file-contains-push.

Document --filecontains

Need to document --filecontains and the corresponding ant property.

Allow for a "dry run" that doesn't actually deploy/pull from SFDC

It'd be nice to gear up for a pull/push to SFDC - but not actually reach out to SFDC (stop before the retrieve/deploy tasks)...

For filecontains pushes, emit the files being pushed

Missed emitting the files to push - emit them so the user knows whats being pushed (and does not need to consult the tmp dir)...

When no files copied in copyFiles, fail the macrodef

When there are no files copied in copyFiles, the macrodef should fail.

Provide ability to generate package.xml and store it

Would be nice to be able to generate package.xml and store to a file without an actual pull.

Allow for multiple SCM clients as a plugin

Although we support git, it'd be nice to support others such as Subversion, CVS or any source control system. I propose we allow a more plugin type functionality:

• scm-status
• scm-push
• scm-destructive-push

We need to be able to then denote the type of scm Solenopsis should use.

We should default to git and git-status. However, we need that functionality pulled out and put into its own XML file. Inclusion of the scm file needs to be done elsewhere - likely solenopsis-setup.xml.

Ability to run all non managed tests

If you use the runAllTests arg in build.xml and you are on an org that has managed packages the build will report as failure if any managed package test class errors. This is very common as managed package test classes will hit validation and mandatory fields in an org.

It would be good if solenopsis could strip out all the test classes and run just the non managed ones. Seeing as you dont get access to managed package code you can just pull * ApexClass and scan for test methods.

destructive-push failed

When I run python solenopsis destructive-push

${rh-util.branch.BRANCH} is echoed instead of the actual value. It didn't seem like an issue until the build failed and I saw that it was in the destructiveChanges.xml itself.

You'll notice that the paths are windows paths, but I get the same results in Fedora 16. I just altered the scripts to run in Windows 7 for our windows developers.

https://gist.github.com/2338708

Look for API version in credentials file and use it if set

If the version is set in the credentials file, use it over sf.apiVersion.

Document how to reconnect to running tests when a timeout arises

Document in the wiki how to reconnect to running tests should a timeout arise.

Document property names in macrodefs - [xml file].[macro def name].VARIABLE

Denote as a standard in the wiki.

Document folder based vs non-folder based and full vs non-full

I still think there is some confusion regarding:

• full
• non-full
• folder
• non-folder

Likely belongs in the how-it-works page