1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# snappy
Snappy is part of Ubuntu Core and enables a fully transactional Ubuntu system.
## Development
### Setting up a GOPATH
When working with the source of Go programs, you should define a path within
your home directory (or other workspace) which will be your `GOPATH`. `GOPATH`
is similar to Java's `CLASSPATH` or Python's `~/.local`. `GOPATH` is documented
[http://golang.org/pkg/go/build/](online) and inside the go tool itself
go help gopath
Various conventions exist for naming the location of your `GOPATH`, but it
should exist, and be writable by you. For example
export GOPATH=${HOME}/work mkdir $GOPATH
will define and create `$HOME/work` as your local `GOPATH`. The `go` tool
itself will create three subdirectories inside your `GOPATH` when required;
`src`, `pkg` and `bin`, which hold the source of Go programs, compiled packages
and compiled binaries, respectively.
Setting `GOPATH` correctly is critical when developing Go programs. Set and
export it as part of your login script.
Add `$GOPATH/bin` to your `PATH`, so you can run the go programs you install:
PATH="$PATH:$GOPATH/bin"
### Getting the snappy sources
The easiest way to get the source for `snappy` is to use the `go get` command.
go get -d -v launchpad.net/snappy/...
This command will checkout the source of `snappy` and inspect it for any unmet
Go package dependencies, downloading those as well. `go get` will also build
and install `snappy` and its dependencies. To checkout without installing, use
the `-d` flag. More details on the `go get` flags are available using
go help get
At this point you will have the git local repository of the `snappy` source at
`$GOPATH/launchpad.net/snappy/snappy`. The source for any
dependent packages will also be available inside `$GOPATH`.
### Building
To build, once the sources are available and `GOPATH` is set, you can just run
go build -o /tmp/snappy launchpad.net/snappy/cmd/snappy
to get the `snappy` binary in /tmp (or without -o to get it in the current
working directory). Alternatively:
go install launchpad.net/snappy/...
to have it available in `$GOPATH/bin`
### Contributing
Contributions are always welcome! Please make sure that you sign the
Canonical contributor licence agreement at
http://www.ubuntu.com/legal/contributors
To get the source and propose a merge, this is what typically needs to
be done:
bzr branch lp:snappy my-work
cd my-work
[hack on mywork]
bzr lp-propose
We value good tests, so when you fix a bug or add a new feature we highly
encourage you to create a test in $source_testing.go. See also the section
about Testing.
### Testing
To run the various tests that we have to ensure a high quality source just run:
./run-checks
This will check if the source format is consistent, that it build, all tests
work as expected and that "go vet" and "golint" have nothing to complain.
You can run individual test with:
go test -check.f $testname
If a test hangs, you can enable verbose mode:
go test -v -check.vv
(or -check.v for less verbose output).
There is more to read about the testing framework on the [website](https://labix.org/gocheck)
### Dependencies handling
To generate dependencies.tsv you need `godeps`, so
go get launchpad.net/godeps
To obtain the correct dependencies for the project, run:
godeps -t -u dependencies.tsv
If the dependencies need updating
godeps -t ./... > dependencies.tsv
|