Fix documentation

Author: David Pinheiro

tunnel/config.go

@@ -10,14 +10,14 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-//Resolver finds specific attributes of a ssh server configured on a ssh config
-//file.
+// Resolver finds specific attributes of a ssh server configured on a ssh config
+// file.
 type Resolver struct {
 	sshConfig *ssh_config.Config
 }
 
-//NewResolver creates a new instance of Resolver based on the given ssh config
-//file path.
+// NewResolver creates a new instance of Resolver based on the given ssh config
+// file path.
 func NewResolver(configPath string) (*Resolver, error) {
 	f, err := os.Open(filepath.Clean(configPath))
 	if err != nil {
@@ -34,9 +34,9 @@ func NewResolver(configPath string) (*Resolver, error) {
 	return &Resolver{sshConfig: cfg}, nil
 }
 
-//Resolve consults a ssh config file to extract some ssh server attributes from
-//it, returning a ResolvedHost. Any attribute which its value is an empty
-//string is an attribute that could not be found in the ssh config file.
+// Resolve consults a ssh config file to extract some ssh server attributes
+// from it, returning a ResolvedHost. Any attribute which its value is an empty
+// string is an attribute that could not be found in the ssh config file.
 func (r Resolver) Resolve(host string) *ResolvedHost {
 	hostname := r.resolveHostname(host)
 
@@ -92,15 +92,15 @@ func (r Resolver) resolveKey(host string) string {
 	return ""
 }
 
-//ResolvedHost holds information extracted from a ssh config file.
+// ResolvedHost holds information extracted from a ssh config file.
 type ResolvedHost struct {
 	Hostname string
 	Port     string
 	User     string
 	Key      string
 }
 
-//String returns a string representation of a ResolvedHost.
+// String returns a string representation of a ResolvedHost.
 func (rh ResolvedHost) String() string {
 	return fmt.Sprintf("[hostname=%s, port=%s, user=%s, key=%s]", rh.Hostname, rh.Port, rh.User, rh.Key)
 }

tunnel/doc.go

@@ -1,8 +1,8 @@
 /*
-tunnel provides APIs to create SSH tunnels to perform local port forwarding,
-leveraging the SSH configuration file (e.g. $HOME/.ssh/config) to find
-specific attributes of the target ssh server like user name, port, host name
-and key when not provided.
+Package tunnel provides APIs to create SSH tunnels to perform local port
+forwarding, leveraging the SSH configuration file (e.g. $HOME/.ssh/config) to
+find specific attributes of the target ssh server like user name, port, host
+name and key when not provided.
 
 SSH Config File Support
 

tunnel/tunnel.go

@@ -15,17 +15,17 @@ import (
 	"golang.org/x/crypto/ssh/knownhosts"
 )
 
-//Server holds the SSH Server attributes used for the client to connect to it.
+// Server holds the SSH Server attributes used for the client to connect to it.
 type Server struct {
 	Name    string
 	Address string
 	User    string
 	Key     string
 }
 
-//NewServer creates a new instance of Server using $HOME/.ssh/config to resolve
-//the missing connection attributes (e.g. user, hostname, port and key)
-//required to connect to the remote server, if any.
+// NewServer creates a new instance of Server using $HOME/.ssh/config to
+// resolve the missing connection attributes (e.g. user, hostname, port and
+// key) required to connect to the remote server, if any.
 func NewServer(user, address, key string) (*Server, error) {
 	var host string
 	var hostname string
@@ -86,21 +86,21 @@ func NewServer(user, address, key string) (*Server, error) {
 	}, nil
 }
 
-//String provided a string representation os a Server.
+// String provided a string representation os a Server.
 func (s Server) String() string {
 	return fmt.Sprintf("[name=%s, address=%s, user=%s, key=%s]", s.Name, s.Address, s.User, s.Key)
 }
 
-//Tunnel represents the ssh tunnel used to forward a local connection to a
-//a remote endpoint through a ssh server.
+// Tunnel represents the ssh tunnel used to forward a local connection to a
+// a remote endpoint through a ssh server.
 type Tunnel struct {
 	local  string
 	server *Server
 	remote string
 	done   chan error
 }
 
-//New creates a new instance of Tunnel
+// New creates a new instance of Tunnel.
 func New(localAddress string, server *Server, remoteAddress string) *Tunnel {
 
 	if localAddress == "" {
@@ -115,8 +115,8 @@ func New(localAddress string, server *Server, remoteAddress string) *Tunnel {
 	}
 }
 
-//Start creates a new ssh tunnel, allowing data exchange between the local and
-//remote endpoints.
+// Start creates a new ssh tunnel, allowing data exchange between the local and
+// remote endpoints.
 func (t *Tunnel) Start() error {
 	local, err := net.Listen("tcp", t.local)
 	if err != nil {
@@ -170,12 +170,12 @@ func (t *Tunnel) forward(localConn net.Conn) error {
 	return nil
 }
 
-//Stop cancels the tunnel, closing all connections.
+// Stop cancels the tunnel, closing all connections.
 func (t Tunnel) Stop() {
 	t.done <- nil
 }
 
-//String returns a string representation of a Tunnel.
+// String returns a string representation of a Tunnel.
 func (t Tunnel) String() string {
 	return fmt.Sprintf("[local:%s, server:%s, remote:%s]", t.local, t.server.Address, t.remote)
 }

tunnel/tunnel_test.go

@@ -126,9 +126,9 @@ func TestMain(m *testing.M) {
 	os.Exit(code)
 }
 
-//prepareTunnel creates a Tunnel object making sure all infrastructure
-//dependencies (ssh and http servers) are ready returning a connection that
-//can be use to reach the remote http server through the tunnel.
+// prepareTunnel creates a Tunnel object making sure all infrastructure
+// dependencies (ssh and http servers) are ready returning a connection that
+// can be use to reach the remote http server through the tunnel.
 func prepareTunnel(t *testing.T) net.Conn {
 	sshAddr := createSSHServer(keyPath)
 	generateKnownHosts(sshAddr.String(), publicKeyPath, knownHostsPath)
@@ -191,8 +191,8 @@ func prepareTestEnv() {
 	os.Setenv("HOME", home)
 }
 
-//newHttpClient create an http client that will always use the given connection
-//to perform http requests.
+// newHttpClient create an http client that will always use the given
+// connection to perform http requests.
 func newHttpClient(conn net.Conn) http.Client {
 	tr := &http.Transport{
 		Dial: func(network, address string) (net.Conn, error) {
@@ -208,11 +208,11 @@ func newHttpClient(conn net.Conn) http.Client {
 	return client
 }
 
-//get performs a http request using the given client appending the given
-//resource to to a hard-coded URL.
+// get performs a http request using the given client appending the given
+// resource to to a hard-coded URL.
 //
-//The request performed by this function is designed to reach the other side
-//through a pipe (net.Pipe()) and this is the reason the URL is hard-coded.
+// The request performed by this function is designed to reach the other side
+// through a pipe (net.Pipe()) and this is the reason the URL is hard-coded.
 func get(client http.Client, resource string) (string, error) {
 	resp, err := client.Get(fmt.Sprintf("%s%s", "http://any-url-is.fine", resource))
 	if err != nil {
@@ -225,11 +225,11 @@ func get(client http.Client, resource string) (string, error) {
 	return string(body), nil
 }
 
-//createWebServer spawns a new http server, listening on a random user port and
-//providing a response identical to the resource provided by the request.
+// createWebServer spawns a new http server, listening on a random user port
+// and providing a response identical to the resource provided by the request.
 //
-//Example: If the request URI is /this-is-a-test, the response will be
-//this-is-a-test
+// Example: If the request URI is /this-is-a-test, the response will be
+// this-is-a-test
 func createWebServer() net.Addr {
 
 	handler := func(w http.ResponseWriter, r *http.Request) {
@@ -245,16 +245,16 @@ func createWebServer() net.Addr {
 	return l.Addr()
 }
 
-//createSSHServer starts a SSH server that authenticates connections using
-//the given keyPath, listens on a random user port and returns the SSH Server
-//address.
+// createSSHServer starts a SSH server that authenticates connections using
+// the given keyPath, listens on a random user port and returns the SSH Server
+// address.
 //
-//The SSH Server created by this function only responds to "direct-tcpip",
-//which is used to establish local port forwarding.
+// The SSH Server created by this function only responds to "direct-tcpip",
+// which is used to establish local port forwarding.
 //
-//References:
-//https://gist.github.com/jpillora/b480fde82bff51a06238
-//https://tools.ietf.org/html/rfc4254#section-7.2
+// References:
+// https://gist.github.com/jpillora/b480fde82bff51a06238
+// https://tools.ietf.org/html/rfc4254#section-7.2
 func createSSHServer(keyPath string) net.Addr {
 	conf := &ssh.ServerConfig{
 		PublicKeyCallback: func(conn ssh.ConnMetadata, key ssh.PublicKey) (*ssh.Permissions, error) {
@@ -309,8 +309,8 @@ func createSSHServer(keyPath string) net.Addr {
 	return l.Addr()
 }
 
-//generateKnownHosts creates a new "known_hosts" file on a given path with a
-//single entry based on the given SSH server address and public key.
+// generateKnownHosts creates a new "known_hosts" file on a given path with a
+// single entry based on the given SSH server address and public key.
 func generateKnownHosts(sshAddr, pubKeyPath, knownHostsPath string) {
 	i := strings.Split(sshAddr, ":")[0]
 	p := strings.Split(sshAddr, ":")[1]