scm-go

implementation of scm in golang

api:

• use('/fhgithub/trigger', this.trigger_handler) //clone and pull force clean done
• use('/fhgithub/listfiles', this.listfiles_handler). //done
• use('/fhgithub/create_tag', this.create_tag_handler). (dont think used)
• use('/fhgithub/list_tags', this.list_tags_handler). //not used
• use('/fhgithub/list_branches', this.list_branches_handler). //not used
• use('/fhgithub/list_remote', this.list_remote_handler). done covers the above two
• use('/fhgithub/zip', this.zip_handler). not used
• use('/fhgithub/archive', this.archive_handler). done
• use('/fhgithub/push', this.push_handler). not used
• use('/fhgithub/mirror', this.mirror_handler). (used by openshift2. mirror does not seem to be an option in libgit2.)
• use('/fhgithub/createfile', this.create_handler). done
• use('/fhgithub/updatefile', this.update_handler). done
• use('/fhgithub/deletefile', this.delete_handler). done
• use('/fhgithub/getfile', this.get_handler). done
• use('/fhgithub/delete_app', this.delete_app_handler). done
• use('/fhgithub/check_commit', this.check_commit_handler). done
• use('/sys', this.sys_handler). ping/health done

Local Development

set up golang

Install golang install

as per install instructions set up the required env vars. The below env vars are what mine are set to

export GOROOT=/usr/local/go
export PATH=$PATH:$GOROOT/bin:/usr/local/go/bin
export GOPATH=/mnt/src/go

setup scm-go

mkdir -p $GOPATH/src/github.com/maleck13
cd $GOPATH/src/github.com/maleck13
git clone git@github.com:maleck13/scm-go.git

#install glide package manager: https://github.com/Masterminds/glide#install
#install dependencies
glide install

libgit2

For local dev I recommend installing libgit2 for dynamic linking https://libgit2.github.com/ Mac osx I had to brew unlink libgit2 as it was an older version.

OSX

brew install pkg-config
brew install libssh2
brew install cmake

#install libgit2 on the mac. Useful for when running tests in intellij
cd $GOPATH/src/github.com/maleck13/scm-go
./scripts/build-libgit2-dynamic.sh

Ubuntu

sudo apt-get install cmake
sudo apt-get install libssh2-1-dev
export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/mnt/src/go/src/github.com/maleck13/scm-go/vendor/libgit2/build/
cd $GOPATH/src/github.com/maleck13/scm-go
./scripts/build-libgit2-dynamic.sh

do a test build. This script builds libgit2.a so that we can static link it into scm-go

  ./scripts/build.sh clean 

run it

  ./scm-go

When testing with RHMAP I run it in the vm (note fhcap branch on the way)

#from inside vm
#change perms of existing repos as running as hadmin
sudo chmod -R 777 /opt/feedhenry/fh-scm/*

./scm-go /etc/feedhenry/fh-scm/conf.json

IDE support

I use the golang plugin for intellij golang plugin

Test

you can run all tests from within intellij or from command line

Run all tests. From root dir of project:

 go test ./...

Run single test file

go test services/git_test.go 

Get coverage... Attempting to get to 70% + coverage as a baseline

go test -cover ./...

Get more verbose output

go test -v services/git_test.go 

Adding new code

write your code. Write your tests. Then pre commit Run

go fmt ./...    formats the go code correctly
godep save -r ./...   ensures deps are from the godep saved dependencies