Merge pull request #1157 from fatih/vim-go-tests

Add travis integration and initial test suite

Author: fatih

.gitignore

@@ -1,2 +1,5 @@
 doc/tags
 .DS_Store
+
+messages.log
+test.log

.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+
+sudo: required
+
+env:
+  global:
+    - DEPS=$HOME/deps
+    - PATH=$DEPS/bin:$PATH
+    - PATCH="v8.0.0134"
+
+install: |
+  git config --global user.email "[email protected]"
+  git config --global user.name "Your Name"
+
+  # check out if we can pre-compiled Vim releases somehow,
+  git clone --branch $PATCH --depth 1 https://github.com/vim/vim
+  cd vim
+  ./configure --prefix=$DEPS --with-features=huge --disable-gui
+  make
+  make install
+  cd -
+
+script: ./scripts/test.sh
+

Makefile

@@ -0,0 +1,7 @@
+all: test
+
+test:
+	@echo "==> Running tests"
+	@./scripts/test.sh
+
+.PHONY: all test

README.md

@@ -1,4 +1,4 @@
-# vim-go
+# vim-go [![Build Status](http://img.shields.io/travis/fatih/vim-go.svg?style=flat-square)](https://travis-ci.org/fatih/vim-go) 
 
 <p align="center">
   <img style="float: right;" src="assets/vim-go.png" alt="Vim-go logo"/>
@@ -288,6 +288,18 @@ information. It includes
 section](https://github.com/fatih/vim-go/wiki/FAQ-Troubleshooting), and many
 other [various pieces](https://github.com/fatih/vim-go/wiki) of information.
 
+## Development & Testing
+
+vim-go supports now test files. Please check `autoload` folder for examples. If
+you add a new feature be sure you also include the `_test.vim` file next to the
+script. You can locally test it by running:
+
+```
+make
+```
+
+Additionally, each new pull request will trigger a new Travis-ci job.
+
 ## Donation
 
 People have asked for this for a long time, now you can be a fully supporter by

Rakefile

@@ -2,26 +2,8 @@
 " Use of this source code is governed by a BSD-style
 " license that can be found in the LICENSE file.
 "
-" fmt.vim: Vim command to format Go files with gofmt.
-"
-" This filetype plugin add a new commands for go buffers:
-"
-"   :Fmt
-"
-"       Filter the current Go buffer through gofmt.
-"       It tries to preserve cursor position and avoids
-"       replacing the buffer with stderr output.
-"
-" Options:
-"
-"   g:go_fmt_command [default="gofmt"]
-"
-"       Flag naming the gofmt executable to use.
-"
-"   g:go_fmt_autosave [default=1]
-"
-"       Flag to auto call :Fmt when saved file
-"
+" fmt.vim: Vim command to format Go files with gofmt (and gofmt compatible
+" toorls, such as goimports).
 
 if !exists("g:go_fmt_command")
   let g:go_fmt_command = "gofmt"
@@ -67,6 +49,13 @@ function! go#fmt#Format(withGoimport) abort
     catch
       let l:curw = winsaveview()
     endtry
+
+    " save our undo file to be restored after we are done. This is needed to
+    " prevent an additional undo jump due to BufWritePre auto command and also
+    " restore 'redo' history because it's getting being destroyed every
+    " BufWritePre
+    let tmpundofile = tempname()
+    exe 'wundo! ' . tmpundofile
   else
     " Save cursor position and many other things.
     let l:curw = winsaveview()
@@ -75,43 +64,116 @@ function! go#fmt#Format(withGoimport) abort
   " Write current unsaved buffer to a temp file
   let l:tmpname = tempname()
   call writefile(getline(1, '$'), l:tmpname)
+  if go#util#IsWin()
+    let l:tmpname = tr(l:tmpname, '\', '/')
+  endif
+
+  let bin_name = g:go_fmt_command
+  if a:withGoimport == 1
+    let bin_name = g:go_goimports_bin
+  endif
+
+  let out = go#fmt#run(bin_name, l:tmpname, expand('%'))
+  if go#util#ShellError() == 0
+    call s:update_file(l:tmpname, expand('%'))
+  elseif g:go_fmt_fail_silently == 0
+    let errors = s:parse_errors(out)
+    call s:show_errors(errors)
+  endif
+
+  " We didn't use the temp file, so clean up
+  call delete(l:tmpname)
 
   if g:go_fmt_experimental == 1
-    " save our undo file to be restored after we are done. This is needed to
-    " prevent an additional undo jump due to BufWritePre auto command and also
-    " restore 'redo' history because it's getting being destroyed every
-    " BufWritePre
-    let tmpundofile = tempname()
-    exe 'wundo! ' . tmpundofile
+    " restore our undo history
+    silent! exe 'rundo ' . tmpundofile
+    call delete(tmpundofile)
+
+    " Restore our cursor/windows positions, folds, etc.
+    if empty(l:curw)
+      silent! loadview
+    else
+      call winrestview(l:curw)
+    endif
+  else
+    " Restore our cursor/windows positions.
+    call winrestview(l:curw)
   endif
+endfunction
 
-  " get the command first so we can test it
-  let bin_name = g:go_fmt_command
-  if a:withGoimport  == 1
-    let bin_name  = g:go_goimports_bin
+" update_file updates the target file with the given formatted source
+function! s:update_file(source, target) 
+  " remove undo point caused via BufWritePre
+  try | silent undojoin | catch | endtry
+
+  let old_fileformat = &fileformat
+  if exists("*getfperm")
+    " save file permissions
+    let original_fperm = getfperm(a:target)
   endif
 
-  " check if the user has installed command binary.
-  " For example if it's goimports, let us check if it's installed,
-  " if not the user get's a warning via go#path#CheckBinPath()
-  let bin_path = go#path#CheckBinPath(bin_name)
-  if empty(bin_path)
-    return
+  call rename(a:source, a:target)
+
+  " restore file permissions
+  if exists("*setfperm") && original_fperm != ''
+    call setfperm(a:target , original_fperm)
   endif
 
-  if bin_name != "gofmt"
+  " reload buffer to reflect latest changes
+  silent edit!
+
+  let &fileformat = old_fileformat
+  let &syntax = &syntax
+
+  " clean up previous location list
+  let l:listtype = "locationlist"
+  call go#list#Clean(l:listtype)
+  call go#list#Window(l:listtype)
+endfunction
+
+" run runs the gofmt/goimport command for the given source file and returns
+" the the output of the executed command. Target is the real file to be
+" formated. 
+function! go#fmt#run(bin_name, source, target) 
+  let cmd = s:fmt_cmd(a:bin_name, a:source, a:target)
+  if cmd[0] == "goimports"
     " change GOPATH too, so goimports can pick up the correct library
     let old_gopath = $GOPATH
     let $GOPATH = go#path#Detect()
   endif
 
-  " populate the final command with user based fmt options
-  let command = bin_path . ' -w '
-  if a:withGoimport  != 1
-    let command  = command . g:go_fmt_options
+  let command = join(cmd, " ")
+
+  " execute our command...
+  let out = go#util#System(command)
+
+  if cmd[0] == "goimports"
+    let $GOPATH = old_gopath
+  endif
+
+  return out
+endfunction
+
+" fmt_cmd returns a dict that contains the command to execute gofmt (or
+" goimports). args is dict with
+function! s:fmt_cmd(bin_name, source, target)
+  " check if the user has installed command binary.
+  " For example if it's goimports, let us check if it's installed,
+  " if not the user get's a warning via go#path#CheckBinPath()
+  let bin_path = go#path#CheckBinPath(a:bin_name)
+  if empty(bin_path)
+    return
   endif
 
-  if bin_name == "goimports"
+  " start constructing the command
+  let cmd = [bin_path]
+  call add(cmd, "-w")
+
+  if a:bin_name != "goimports"
+    call extend(cmd, split(g:go_fmt_options, " "))
+  else
+    " lazy check if goimports support `-srcdir`. We should eventually remove
+    " this in the future
     if !exists('b:goimports_vendor_compatible')
       let out = go#util#System(bin_path . " --help")
       if out !~ "-srcdir"
@@ -124,95 +186,47 @@ function! go#fmt#Format(withGoimport) abort
     if exists('b:goimports_vendor_compatible') && b:goimports_vendor_compatible
       let ssl_save = &shellslash
       set noshellslash
-      let command  = command . '-srcdir ' . shellescape(expand("%:p"))
+      call extend(cmd, ["-srcdir", shellescape(fnamemodify(a:target, ":p"))])
       let &shellslash = ssl_save
     endif
   endif
 
-  " execute our command...
-  if go#util#IsWin()
-    let l:tmpname = tr(l:tmpname, '\', '/')
-  endif
-  let out = go#util#System(command . " " . l:tmpname)
-
-  if bin_name != "gofmt"
-    let $GOPATH = old_gopath
-  endif
+  call add(cmd, a:source)
+  return cmd
+endfunction
 
-  let l:listtype = "locationlist"
-  "if there is no error on the temp file replace the output with the current
-  "file (if this fails, we can always check the outputs first line with:
-  "splitted =~ 'package \w\+')
-  if go#util#ShellError() == 0
-    " remove undo point caused via BufWritePre
-    try | silent undojoin | catch | endtry
-
-    " Replace current file with temp file, then reload buffer
-    let old_fileformat = &fileformat
-    if exists("*getfperm")
-      " save old file permissions
-      let original_fperm = getfperm(expand('%'))
-    endif
-    call rename(l:tmpname, expand('%'))
-    " restore old file permissions
-    if exists("*setfperm") && original_fperm != ''
-      call setfperm(expand('%'), original_fperm)
-    endif
-    silent edit!
-    let &fileformat = old_fileformat
-    let &syntax = &syntax
-
-    " clean up previous location list, but only if it's due to fmt
-    if exists('b:got_fmt_error') && b:got_fmt_error
-      let b:got_fmt_error = 0
-      call go#list#Clean(l:listtype)
-      call go#list#Window(l:listtype)
-    endif
-  elseif g:go_fmt_fail_silently == 0
-    let splitted = split(out, '\n')
-    "otherwise get the errors and put them to location list
-    let errors = []
-    for line in splitted
-      let tokens = matchlist(line, '^\(.\{-}\):\(\d\+\):\(\d\+\)\s*\(.*\)')
-      if !empty(tokens)
-        call add(errors, {"filename": @%,
-              \"lnum":     tokens[2],
-              \"col":      tokens[3],
-              \"text":     tokens[4]})
-      endif
-    endfor
-    if empty(errors)
-      % | " Couldn't detect gofmt error format, output errors
-    endif
-    if !empty(errors)
-      call go#list#Populate(l:listtype, errors, 'Format')
-      echohl Error | echomsg "Gofmt returned error" | echohl None
+" parse_errors parses the given errors and returns a list of parsed errors
+function! s:parse_errors(content) abort
+  let splitted = split(a:content, '\n')
+
+  " list of errors to be put into location list
+  let errors = []
+  for line in splitted
+    let tokens = matchlist(line, '^\(.\{-}\):\(\d\+\):\(\d\+\)\s*\(.*\)')
+    if !empty(tokens)
+      call add(errors,{
+            \"lnum":     tokens[2],
+            \"col":      tokens[3],
+            \"text":     tokens[4],
+            \ })
     endif
+  endfor
 
-    let b:got_fmt_error = 1
-    call go#list#Window(l:listtype, len(errors))
+  return errors
+endfunction
 
-    " We didn't use the temp file, so clean up
-    call delete(l:tmpname)
+" show_errors opens a location list and shows the given errors. If the given
+" errors is empty, it closes the the location list
+function! s:show_errors(errors) abort
+  let l:listtype = "locationlist" 
+  if !empty(a:errors)
+    call go#list#Populate(l:listtype, a:errors, 'Format')
+    echohl Error | echomsg "Gofmt returned error" | echohl None
   endif
 
-  if g:go_fmt_experimental == 1
-    " restore our undo history
-    silent! exe 'rundo ' . tmpundofile
-    call delete(tmpundofile)
-  endif
-
-  if g:go_fmt_experimental == 1
-    " Restore our cursor/windows positions, folds, etc.
-    if empty(l:curw)
-      silent! loadview
-    else
-      call winrestview(l:curw)
-    endif
-  else
-    " Restore our cursor/windows positions.
-    call winrestview(l:curw)
-  endif
+  " this closes the window if there are no errors or it opens 
+  " it if there is any
+  call go#list#Window(l:listtype, len(a:errors))
 endfunction
 
 function! go#fmt#ToggleFmtAutoSave() abort
@@ -225,4 +239,5 @@ function! go#fmt#ToggleFmtAutoSave() abort
   let g:go_fmt_autosave = 1
   call go#util#EchoProgress("auto fmt enabled")
 endfunction
+
 " vim: sw=2 ts=2 et