mirror of
https://github.com/Luzifer/vault-openvpn.git
synced 2024-12-25 14:21:21 +00:00
Deps: Add new dependencies
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
parent
2f084643bf
commit
6889a770a3
116 changed files with 1142 additions and 11322 deletions
99
Gopkg.lock
generated
99
Gopkg.lock
generated
|
@ -2,47 +2,70 @@
|
||||||
|
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:ee78642771740eca7c441874da0191c824ad7b62f726f853d535d88225eb7acf"
|
||||||
|
name = "github.com/Luzifer/go-dhparam"
|
||||||
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
|
revision = "b6a915824fd6c962b34692aefea264c89cd23c25"
|
||||||
|
version = "v1.0.0"
|
||||||
|
|
||||||
|
[[projects]]
|
||||||
|
digest = "1:1b91ae0dc69a41d4c2ed23ea5cffb721ea63f5037ca4b81e6d6771fbb8f45129"
|
||||||
name = "github.com/fsnotify/fsnotify"
|
name = "github.com/fsnotify/fsnotify"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "c2828203cd70a50dcccfb2761f8b1f8ceef9a8e9"
|
revision = "c2828203cd70a50dcccfb2761f8b1f8ceef9a8e9"
|
||||||
version = "v1.4.7"
|
version = "v1.4.7"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:9413ddbde906f91f062fda0dfa9a7cff43458cd1b2282c0fa25c61d89300b116"
|
||||||
name = "github.com/golang/snappy"
|
name = "github.com/golang/snappy"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "553a641470496b2327abcac10b36396bd98e45c9"
|
revision = "553a641470496b2327abcac10b36396bd98e45c9"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:f0d9d74edbd40fdeada436d5ac9cb5197407899af3fef85ff0137077ffe8ae19"
|
||||||
name = "github.com/hashicorp/errwrap"
|
name = "github.com/hashicorp/errwrap"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "7554cd9344cec97297fa6649b055a8c98c2a1e55"
|
revision = "7554cd9344cec97297fa6649b055a8c98c2a1e55"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:a5d940c38bf56f121721bfa747c66356df387cb9d5318c570c6d4170aab62862"
|
||||||
name = "github.com/hashicorp/go-cleanhttp"
|
name = "github.com/hashicorp/go-cleanhttp"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "d5fe4b57a186c716b0e00b8c301cbd9b4182694d"
|
revision = "d5fe4b57a186c716b0e00b8c301cbd9b4182694d"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:4d55897d00e9b53c1c716e8fe504de3d21bec8edba0a330bfaa87902695e46e2"
|
||||||
name = "github.com/hashicorp/go-multierror"
|
name = "github.com/hashicorp/go-multierror"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "b7773ae218740a7be65057fc60b366a49b538a44"
|
revision = "b7773ae218740a7be65057fc60b366a49b538a44"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:cdb5ce76cd7af19e3d2d5ba9b6458a2ee804f0d376711215dd3df5f51100d423"
|
||||||
name = "github.com/hashicorp/go-rootcerts"
|
name = "github.com/hashicorp/go-rootcerts"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "6bb64b370b90e7ef1fa532be9e591a81c3493e00"
|
revision = "6bb64b370b90e7ef1fa532be9e591a81c3493e00"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:0c539f680465786826d5022b7528ee42086d13d298782e5479506cd7c12e2daa"
|
||||||
name = "github.com/hashicorp/go-sockaddr"
|
name = "github.com/hashicorp/go-sockaddr"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "7165ee14aff120ee3642aa2bcf2dea8eebef29c3"
|
revision = "7165ee14aff120ee3642aa2bcf2dea8eebef29c3"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:11c6c696067d3127ecf332b10f89394d386d9083f82baf71f40f2da31841a009"
|
||||||
name = "github.com/hashicorp/hcl"
|
name = "github.com/hashicorp/hcl"
|
||||||
packages = [
|
packages = [
|
||||||
".",
|
".",
|
||||||
|
@ -54,11 +77,13 @@
|
||||||
"hcl/token",
|
"hcl/token",
|
||||||
"json/parser",
|
"json/parser",
|
||||||
"json/scanner",
|
"json/scanner",
|
||||||
"json/token"
|
"json/token",
|
||||||
]
|
]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "ef8a98b0bbce4a65b5aa4c368430a80ddc533168"
|
revision = "ef8a98b0bbce4a65b5aa4c368430a80ddc533168"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:703439a234b0f6366136be3f6aac6abb7886a3b4f81278f5be96c4bfd9a43087"
|
||||||
name = "github.com/hashicorp/vault"
|
name = "github.com/hashicorp/vault"
|
||||||
packages = [
|
packages = [
|
||||||
"api",
|
"api",
|
||||||
|
@ -67,134 +92,182 @@
|
||||||
"helper/errutil",
|
"helper/errutil",
|
||||||
"helper/jsonutil",
|
"helper/jsonutil",
|
||||||
"helper/parseutil",
|
"helper/parseutil",
|
||||||
"helper/strutil"
|
"helper/strutil",
|
||||||
]
|
]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "756fdc4587350daf1c65b93647b2cc31a6f119cd"
|
revision = "756fdc4587350daf1c65b93647b2cc31a6f119cd"
|
||||||
version = "v0.10.1"
|
version = "v0.10.1"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:406338ad39ab2e37b7f4452906442a3dbf0eb3379dd1f06aafb5c07e769a5fbb"
|
||||||
name = "github.com/inconshreveable/mousetrap"
|
name = "github.com/inconshreveable/mousetrap"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "76626ae9c91c4f2a10f34cad8ce83ea42c93bb75"
|
revision = "76626ae9c91c4f2a10f34cad8ce83ea42c93bb75"
|
||||||
version = "v1.0"
|
version = "v1.0"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:d244f8666a838fe6ad70ec8fe77f50ebc29fdc3331a2729ba5886bef8435d10d"
|
||||||
name = "github.com/magiconair/properties"
|
name = "github.com/magiconair/properties"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "c2353362d570a7bfa228149c62842019201cfb71"
|
revision = "c2353362d570a7bfa228149c62842019201cfb71"
|
||||||
version = "v1.8.0"
|
version = "v1.8.0"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:cb591533458f6eb6e2c1065ff3eac6b50263d7847deb23fc9f79b25bc608970e"
|
||||||
name = "github.com/mattn/go-runewidth"
|
name = "github.com/mattn/go-runewidth"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "9e777a8366cce605130a531d2cd6363d07ad7317"
|
revision = "9e777a8366cce605130a531d2cd6363d07ad7317"
|
||||||
version = "v0.0.2"
|
version = "v0.0.2"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:9db29b604bd78452d167abed82386ddd2f93973df3841896fb6ab8aff936f1d6"
|
||||||
name = "github.com/mitchellh/go-homedir"
|
name = "github.com/mitchellh/go-homedir"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "3864e76763d94a6df2f9960b16a20a33da9f9a66"
|
revision = "3864e76763d94a6df2f9960b16a20a33da9f9a66"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:4b9dacaf3496e8bd82173b88c38004028a103b03ddd2de15a0a108f04619e00b"
|
||||||
name = "github.com/mitchellh/mapstructure"
|
name = "github.com/mitchellh/mapstructure"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "a4e142e9c047c904fa2f1e144d9a84e6133024bc"
|
revision = "a4e142e9c047c904fa2f1e144d9a84e6133024bc"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:e6baebf0bd20950e285254902a8f2241b4870528fb63fdc10460c67b1f31b1a3"
|
||||||
name = "github.com/olekukonko/tablewriter"
|
name = "github.com/olekukonko/tablewriter"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "d4647c9c7a84d847478d890b816b7d8b62b0b279"
|
revision = "d4647c9c7a84d847478d890b816b7d8b62b0b279"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:13b8f1a2ce177961dc9231606a52f709fab896c565f3988f60a7f6b4e543a902"
|
||||||
name = "github.com/pelletier/go-toml"
|
name = "github.com/pelletier/go-toml"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "acdc4509485b587f5e675510c4f2c63e90ff68a8"
|
revision = "acdc4509485b587f5e675510c4f2c63e90ff68a8"
|
||||||
version = "v1.1.0"
|
version = "v1.1.0"
|
||||||
|
|
||||||
|
[[projects]]
|
||||||
|
digest = "1:5cf3f025cbee5951a4ee961de067c8a89fc95a5adabead774f82822efabab121"
|
||||||
|
name = "github.com/pkg/errors"
|
||||||
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
|
revision = "645ef00459ed84a119197bfb8d8205042c6df63d"
|
||||||
|
version = "v0.8.0"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:09d61699d553a4e6ec998ad29816177b1f3d3ed0c18fe923d2c174ec065c99c8"
|
||||||
name = "github.com/ryanuber/go-glob"
|
name = "github.com/ryanuber/go-glob"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "256dc444b735e061061cf46c809487313d5b0065"
|
revision = "256dc444b735e061061cf46c809487313d5b0065"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:45010b961ea5349797980f57e2b7cd54b398d71ec3aba056a6bf2916d7cce024"
|
||||||
name = "github.com/sethgrid/pester"
|
name = "github.com/sethgrid/pester"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "ed9870dad3170c0b25ab9b11830cc57c3a7798fb"
|
revision = "ed9870dad3170c0b25ab9b11830cc57c3a7798fb"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:6989062eb7ccf25cf38bf4fe3dba097ee209f896cda42cefdca3927047bef7b6"
|
||||||
name = "github.com/sirupsen/logrus"
|
name = "github.com/sirupsen/logrus"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "c155da19408a8799da419ed3eeb0cb5db0ad5dbc"
|
revision = "c155da19408a8799da419ed3eeb0cb5db0ad5dbc"
|
||||||
version = "v1.0.5"
|
version = "v1.0.5"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:35f36ea322654e3d0932e58ad26556998260b9fa9e691471f756d173684eac0a"
|
||||||
name = "github.com/spf13/afero"
|
name = "github.com/spf13/afero"
|
||||||
packages = [
|
packages = [
|
||||||
".",
|
".",
|
||||||
"mem"
|
"mem",
|
||||||
]
|
]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "63644898a8da0bc22138abf860edaf5277b6102e"
|
revision = "63644898a8da0bc22138abf860edaf5277b6102e"
|
||||||
version = "v1.1.0"
|
version = "v1.1.0"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:3fa7947ca83b98ae553590d993886e845a4bff19b7b007e869c6e0dd3b9da9cd"
|
||||||
name = "github.com/spf13/cast"
|
name = "github.com/spf13/cast"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "8965335b8c7107321228e3e3702cab9832751bac"
|
revision = "8965335b8c7107321228e3e3702cab9832751bac"
|
||||||
version = "v1.2.0"
|
version = "v1.2.0"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:343d44e06621142ab09ae0c76c1799104cdfddd3ffb445d78b1adf8dc3ffaf3d"
|
||||||
name = "github.com/spf13/cobra"
|
name = "github.com/spf13/cobra"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "ef82de70bb3f60c65fb8eebacbb2d122ef517385"
|
revision = "ef82de70bb3f60c65fb8eebacbb2d122ef517385"
|
||||||
version = "v0.0.3"
|
version = "v0.0.3"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:f29f83301ed096daed24a90f4af591b7560cb14b9cc3e1827abbf04db7269ab5"
|
||||||
name = "github.com/spf13/jwalterweatherman"
|
name = "github.com/spf13/jwalterweatherman"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "7c0cea34c8ece3fbeb2b27ab9b59511d360fb394"
|
revision = "7c0cea34c8ece3fbeb2b27ab9b59511d360fb394"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:15e5c398fbd9d2c439b635a08ac161b13d04f0c2aa587fe256b65dc0c3efe8b7"
|
||||||
name = "github.com/spf13/pflag"
|
name = "github.com/spf13/pflag"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "583c0c0531f06d5278b7d917446061adc344b5cd"
|
revision = "583c0c0531f06d5278b7d917446061adc344b5cd"
|
||||||
version = "v1.0.1"
|
version = "v1.0.1"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:ea67fb4941c0a1a92f828e73cf426533c71db02df45a2cdf55a14c3e7b74c07a"
|
||||||
name = "github.com/spf13/viper"
|
name = "github.com/spf13/viper"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "b5e8006cbee93ec955a89ab31e0e3ce3204f3736"
|
revision = "b5e8006cbee93ec955a89ab31e0e3ce3204f3736"
|
||||||
version = "v1.0.2"
|
version = "v1.0.2"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:3f3a05ae0b95893d90b9b3b5afdb79a9b3d96e4e36e099d841ae602e4aca0da8"
|
||||||
name = "golang.org/x/crypto"
|
name = "golang.org/x/crypto"
|
||||||
packages = ["ssh/terminal"]
|
packages = ["ssh/terminal"]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "ab813273cd59e1333f7ae7bff5d027d4aadf528c"
|
revision = "ab813273cd59e1333f7ae7bff5d027d4aadf528c"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:aff5fb0c8a4eaa5967146b2efa1a1e59b6195cf40574ab4983a5f222898f0660"
|
||||||
name = "golang.org/x/net"
|
name = "golang.org/x/net"
|
||||||
packages = [
|
packages = [
|
||||||
"http2",
|
"http2",
|
||||||
"http2/hpack",
|
"http2/hpack",
|
||||||
"idna",
|
"idna",
|
||||||
"lex/httplex"
|
"lex/httplex",
|
||||||
]
|
]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "f5dfe339be1d06f81b22525fe34671ee7d2c8904"
|
revision = "f5dfe339be1d06f81b22525fe34671ee7d2c8904"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
|
digest = "1:0dbe2a3199cde81dd841ea2de1386165f953d227ddb2b5c2c4b591209bf37746"
|
||||||
name = "golang.org/x/sys"
|
name = "golang.org/x/sys"
|
||||||
packages = [
|
packages = [
|
||||||
"unix",
|
"unix",
|
||||||
"windows"
|
"windows",
|
||||||
]
|
]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "c11f84a56e43e20a78cee75a7c034031ecf57d1f"
|
revision = "c11f84a56e43e20a78cee75a7c034031ecf57d1f"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:e7071ed636b5422cc51c0e3a6cebc229d6c9fffc528814b519a980641422d619"
|
||||||
name = "golang.org/x/text"
|
name = "golang.org/x/text"
|
||||||
packages = [
|
packages = [
|
||||||
"collate",
|
"collate",
|
||||||
|
@ -210,20 +283,32 @@
|
||||||
"unicode/bidi",
|
"unicode/bidi",
|
||||||
"unicode/cldr",
|
"unicode/cldr",
|
||||||
"unicode/norm",
|
"unicode/norm",
|
||||||
"unicode/rangetable"
|
"unicode/rangetable",
|
||||||
]
|
]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "f21a4dfb5e38f5895301dc265a8def02365cc3d0"
|
revision = "f21a4dfb5e38f5895301dc265a8def02365cc3d0"
|
||||||
version = "v0.3.0"
|
version = "v0.3.0"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
digest = "1:7c95b35057a0ff2e19f707173cc1a947fa43a6eb5c4d300d196ece0334046082"
|
||||||
name = "gopkg.in/yaml.v2"
|
name = "gopkg.in/yaml.v2"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
pruneopts = "NUT"
|
||||||
revision = "5420a8b6744d3b0345ab293f6fcba19c978f1183"
|
revision = "5420a8b6744d3b0345ab293f6fcba19c978f1183"
|
||||||
version = "v2.2.1"
|
version = "v2.2.1"
|
||||||
|
|
||||||
[solve-meta]
|
[solve-meta]
|
||||||
analyzer-name = "dep"
|
analyzer-name = "dep"
|
||||||
analyzer-version = 1
|
analyzer-version = 1
|
||||||
inputs-digest = "d5c94eece84d41716e83088082c119c84736465b21834e66ed176c3ba5bbccf5"
|
input-imports = [
|
||||||
|
"github.com/Luzifer/go-dhparam",
|
||||||
|
"github.com/hashicorp/vault/api",
|
||||||
|
"github.com/hashicorp/vault/helper/certutil",
|
||||||
|
"github.com/mitchellh/go-homedir",
|
||||||
|
"github.com/olekukonko/tablewriter",
|
||||||
|
"github.com/sirupsen/logrus",
|
||||||
|
"github.com/spf13/cobra",
|
||||||
|
"github.com/spf13/viper",
|
||||||
|
]
|
||||||
solver-name = "gps-cdcl"
|
solver-name = "gps-cdcl"
|
||||||
solver-version = 1
|
solver-version = 1
|
||||||
|
|
|
@ -29,6 +29,10 @@
|
||||||
name = "github.com/hashicorp/vault"
|
name = "github.com/hashicorp/vault"
|
||||||
version = "0.10.1"
|
version = "0.10.1"
|
||||||
|
|
||||||
|
[[constraint]]
|
||||||
|
name = "github.com/Luzifer/go-dhparam"
|
||||||
|
version = "^1.0.0"
|
||||||
|
|
||||||
[[constraint]]
|
[[constraint]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
name = "github.com/mitchellh/go-homedir"
|
name = "github.com/mitchellh/go-homedir"
|
||||||
|
@ -50,5 +54,6 @@
|
||||||
version = "1.0.2"
|
version = "1.0.2"
|
||||||
|
|
||||||
[prune]
|
[prune]
|
||||||
|
non-go = true
|
||||||
go-tests = true
|
go-tests = true
|
||||||
unused-packages = true
|
unused-packages = true
|
||||||
|
|
|
@ -14,7 +14,7 @@ import (
|
||||||
"text/template"
|
"text/template"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
dhparam "github.com/Luzifer/go-dhparams"
|
dhparam "github.com/Luzifer/go-dhparam"
|
||||||
"github.com/hashicorp/vault/api"
|
"github.com/hashicorp/vault/api"
|
||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
"github.com/spf13/viper"
|
"github.com/spf13/viper"
|
||||||
|
|
|
@ -1,37 +1,3 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initApache2() {
|
|
||||||
Licenses["apache"] = License{
|
|
||||||
Name: "Apache 2.0",
|
|
||||||
PossibleMatches: []string{"apache", "apache20", "apache 2.0", "apache2.0", "apache-2.0"},
|
|
||||||
Header: `
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.`,
|
|
||||||
Text: `
|
|
||||||
Apache License
|
Apache License
|
||||||
Version 2.0, January 2004
|
Version 2.0, January 2004
|
||||||
http://www.apache.org/licenses/
|
http://www.apache.org/licenses/
|
||||||
|
@ -220,7 +186,7 @@ limitations under the License.`,
|
||||||
same "printed page" as the copyright notice for easier
|
same "printed page" as the copyright notice for easier
|
||||||
identification within third-party archives.
|
identification within third-party archives.
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
Copyright 2018- Knut Ahlers <knut@ahlers.me>
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
@ -233,6 +199,4 @@ limitations under the License.`,
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
See the License for the specific language governing permissions and
|
See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
44
vendor/github.com/Luzifer/go-dhparam/dh.go
generated
vendored
Normal file
44
vendor/github.com/Luzifer/go-dhparam/dh.go
generated
vendored
Normal file
|
@ -0,0 +1,44 @@
|
||||||
|
package dhparam
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/asn1"
|
||||||
|
"encoding/pem"
|
||||||
|
"math/big"
|
||||||
|
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DH contains a prime (P) and a generator (G) number representing the DH parameters
|
||||||
|
type DH struct {
|
||||||
|
P *big.Int
|
||||||
|
G int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decode reads a DH parameters struct from its PEM data
|
||||||
|
func Decode(pemData []byte) (*DH, error) {
|
||||||
|
blk, _ := pem.Decode(pemData)
|
||||||
|
|
||||||
|
out := &DH{}
|
||||||
|
if _, err := asn1.Unmarshal(blk.Bytes, out); err != nil {
|
||||||
|
return nil, errors.Wrap(err, "Could not unmarshal ASN1")
|
||||||
|
}
|
||||||
|
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToPEM encodes the DH parameters using ASN1 and PEM encoding
|
||||||
|
func (d DH) ToPEM() ([]byte, error) {
|
||||||
|
data, err := asn1.Marshal(d)
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrap(err, "Unable to marshal ASN1 data")
|
||||||
|
}
|
||||||
|
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
err = pem.Encode(buf, &pem.Block{
|
||||||
|
Type: pemHeader,
|
||||||
|
Bytes: data,
|
||||||
|
})
|
||||||
|
|
||||||
|
return buf.Bytes(), err
|
||||||
|
}
|
163
vendor/github.com/Luzifer/go-dhparam/generator.go
generated
vendored
Normal file
163
vendor/github.com/Luzifer/go-dhparam/generator.go
generated
vendored
Normal file
|
@ -0,0 +1,163 @@
|
||||||
|
package dhparam
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/rand"
|
||||||
|
"math/big"
|
||||||
|
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
const pemHeader = "DH PARAMETERS"
|
||||||
|
|
||||||
|
// GeneratorResult is a type of results sent to the GeneratorCallback function
|
||||||
|
type GeneratorResult uint
|
||||||
|
|
||||||
|
const (
|
||||||
|
// GeneratorFoundPossiblePrime signals a possible (non-verified) prime number was found (OpenSSL: ".")
|
||||||
|
GeneratorFoundPossiblePrime GeneratorResult = iota
|
||||||
|
// GeneratorFirstConfirmation signals the prime number itself was verified but is not yet considered "safe" (OpenSSL: "+")
|
||||||
|
GeneratorFirstConfirmation
|
||||||
|
// GeneratorSafePrimeFound signals the prime number now is considered "safe" (OpenSSL: "*")
|
||||||
|
GeneratorSafePrimeFound
|
||||||
|
)
|
||||||
|
|
||||||
|
// Generator is the generator number to use when determining the prime number
|
||||||
|
type Generator int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// GeneratorTwo uses a generator 2
|
||||||
|
GeneratorTwo Generator = 2
|
||||||
|
// GeneratorFive uses a generator 5
|
||||||
|
GeneratorFive = 5
|
||||||
|
)
|
||||||
|
|
||||||
|
// GeneratorCallback is a type of function to receive GeneratorResults while the prime number is determined
|
||||||
|
type GeneratorCallback func(r GeneratorResult)
|
||||||
|
|
||||||
|
func nullCallback(r GeneratorResult) {}
|
||||||
|
|
||||||
|
// Generate determines a prime number according to the generator having the specified number of bits
|
||||||
|
//
|
||||||
|
// In OpenSSL defined generators are 2 and 5. Others are supported but the verification is not supported in an extend as with generators 2 and 5.
|
||||||
|
// The bit size should be adjusted to be high enough for the current requirements. Also you should keep
|
||||||
|
// in mind the higher the bitsize, the longer the generation might take.
|
||||||
|
func Generate(bits int, generator Generator, cb GeneratorCallback) (*DH, error) {
|
||||||
|
var (
|
||||||
|
err error
|
||||||
|
padd, rem int64
|
||||||
|
prime *big.Int
|
||||||
|
)
|
||||||
|
|
||||||
|
if cb == nil {
|
||||||
|
cb = nullCallback
|
||||||
|
}
|
||||||
|
|
||||||
|
switch generator {
|
||||||
|
case 2:
|
||||||
|
padd, rem = 24, 11
|
||||||
|
case 5:
|
||||||
|
padd, rem = 10, 3
|
||||||
|
default:
|
||||||
|
padd, rem = 2, 1
|
||||||
|
}
|
||||||
|
|
||||||
|
for {
|
||||||
|
if prime, err = genPrime(bits, big.NewInt(padd), big.NewInt(rem)); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if prime.BitLen() > bits {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
t := new(big.Int)
|
||||||
|
t.Rsh(prime, 1)
|
||||||
|
|
||||||
|
cb(GeneratorFoundPossiblePrime)
|
||||||
|
|
||||||
|
if prime.ProbablyPrime(0) {
|
||||||
|
cb(GeneratorFirstConfirmation)
|
||||||
|
} else {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if t.ProbablyPrime(0) {
|
||||||
|
cb(GeneratorSafePrimeFound)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return &DH{
|
||||||
|
P: prime,
|
||||||
|
G: int(generator),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func genPrime(bits int, padd, rem *big.Int) (*big.Int, error) {
|
||||||
|
var (
|
||||||
|
err error
|
||||||
|
p = new(big.Int)
|
||||||
|
qadd = new(big.Int)
|
||||||
|
q = new(big.Int)
|
||||||
|
t1 = new(big.Int)
|
||||||
|
)
|
||||||
|
|
||||||
|
bits--
|
||||||
|
|
||||||
|
qadd.Rsh(padd, 1)
|
||||||
|
|
||||||
|
if q, err = genRand(bits); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
t1.Mod(q, qadd)
|
||||||
|
q.Sub(q, t1)
|
||||||
|
|
||||||
|
t1.Rsh(rem, 1)
|
||||||
|
q.Add(q, t1)
|
||||||
|
|
||||||
|
p.Lsh(q, 1)
|
||||||
|
p.Add(p, big.NewInt(1))
|
||||||
|
|
||||||
|
for !mightBePrime(p) || !mightBePrime(q) {
|
||||||
|
p.Add(p, padd)
|
||||||
|
q.Add(q, qadd)
|
||||||
|
}
|
||||||
|
|
||||||
|
return p, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func mightBePrime(i *big.Int) bool {
|
||||||
|
m := new(big.Int)
|
||||||
|
for _, p := range quickTestPrimes {
|
||||||
|
if m.Mod(i, big.NewInt(p)).Int64() == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func genRand(bits int) (*big.Int, error) {
|
||||||
|
bytes := (bits + 7) / 8
|
||||||
|
bit := (bits - 1) % 8
|
||||||
|
mask := 0xff << uint(bit+1)
|
||||||
|
|
||||||
|
buf := make([]byte, bytes)
|
||||||
|
if _, err := rand.Read(buf); err != nil {
|
||||||
|
return nil, errors.Wrap(err, "Unable to read random")
|
||||||
|
}
|
||||||
|
|
||||||
|
if bit == 0 {
|
||||||
|
buf[0] = 1
|
||||||
|
buf[1] |= 0x80
|
||||||
|
} else {
|
||||||
|
buf[0] |= (3 << uint(bit-1))
|
||||||
|
}
|
||||||
|
|
||||||
|
buf[0] &= byte(^mask)
|
||||||
|
|
||||||
|
buf[bytes-1] |= 1
|
||||||
|
|
||||||
|
r := new(big.Int)
|
||||||
|
return r.SetBytes(buf), nil
|
||||||
|
}
|
261
vendor/github.com/Luzifer/go-dhparam/primes.go
generated
vendored
Normal file
261
vendor/github.com/Luzifer/go-dhparam/primes.go
generated
vendored
Normal file
|
@ -0,0 +1,261 @@
|
||||||
|
package dhparam
|
||||||
|
|
||||||
|
var quickTestPrimes = []int64{
|
||||||
|
// 2, // two is not checked in openssl code
|
||||||
|
3, 5, 7, 11, 13, 17, 19,
|
||||||
|
23, 29, 31, 37, 41, 43, 47, 53,
|
||||||
|
59, 61, 67, 71, 73, 79, 83, 89,
|
||||||
|
97, 101, 103, 107, 109, 113, 127, 131,
|
||||||
|
137, 139, 149, 151, 157, 163, 167, 173,
|
||||||
|
179, 181, 191, 193, 197, 199, 211, 223,
|
||||||
|
227, 229, 233, 239, 241, 251, 257, 263,
|
||||||
|
269, 271, 277, 281, 283, 293, 307, 311,
|
||||||
|
313, 317, 331, 337, 347, 349, 353, 359,
|
||||||
|
367, 373, 379, 383, 389, 397, 401, 409,
|
||||||
|
419, 421, 431, 433, 439, 443, 449, 457,
|
||||||
|
461, 463, 467, 479, 487, 491, 499, 503,
|
||||||
|
509, 521, 523, 541, 547, 557, 563, 569,
|
||||||
|
571, 577, 587, 593, 599, 601, 607, 613,
|
||||||
|
617, 619, 631, 641, 643, 647, 653, 659,
|
||||||
|
661, 673, 677, 683, 691, 701, 709, 719,
|
||||||
|
727, 733, 739, 743, 751, 757, 761, 769,
|
||||||
|
773, 787, 797, 809, 811, 821, 823, 827,
|
||||||
|
829, 839, 853, 857, 859, 863, 877, 881,
|
||||||
|
883, 887, 907, 911, 919, 929, 937, 941,
|
||||||
|
947, 953, 967, 971, 977, 983, 991, 997,
|
||||||
|
1009, 1013, 1019, 1021, 1031, 1033, 1039, 1049,
|
||||||
|
1051, 1061, 1063, 1069, 1087, 1091, 1093, 1097,
|
||||||
|
1103, 1109, 1117, 1123, 1129, 1151, 1153, 1163,
|
||||||
|
1171, 1181, 1187, 1193, 1201, 1213, 1217, 1223,
|
||||||
|
1229, 1231, 1237, 1249, 1259, 1277, 1279, 1283,
|
||||||
|
1289, 1291, 1297, 1301, 1303, 1307, 1319, 1321,
|
||||||
|
1327, 1361, 1367, 1373, 1381, 1399, 1409, 1423,
|
||||||
|
1427, 1429, 1433, 1439, 1447, 1451, 1453, 1459,
|
||||||
|
1471, 1481, 1483, 1487, 1489, 1493, 1499, 1511,
|
||||||
|
1523, 1531, 1543, 1549, 1553, 1559, 1567, 1571,
|
||||||
|
1579, 1583, 1597, 1601, 1607, 1609, 1613, 1619,
|
||||||
|
1621, 1627, 1637, 1657, 1663, 1667, 1669, 1693,
|
||||||
|
1697, 1699, 1709, 1721, 1723, 1733, 1741, 1747,
|
||||||
|
1753, 1759, 1777, 1783, 1787, 1789, 1801, 1811,
|
||||||
|
1823, 1831, 1847, 1861, 1867, 1871, 1873, 1877,
|
||||||
|
1879, 1889, 1901, 1907, 1913, 1931, 1933, 1949,
|
||||||
|
1951, 1973, 1979, 1987, 1993, 1997, 1999, 2003,
|
||||||
|
2011, 2017, 2027, 2029, 2039, 2053, 2063, 2069,
|
||||||
|
2081, 2083, 2087, 2089, 2099, 2111, 2113, 2129,
|
||||||
|
2131, 2137, 2141, 2143, 2153, 2161, 2179, 2203,
|
||||||
|
2207, 2213, 2221, 2237, 2239, 2243, 2251, 2267,
|
||||||
|
2269, 2273, 2281, 2287, 2293, 2297, 2309, 2311,
|
||||||
|
2333, 2339, 2341, 2347, 2351, 2357, 2371, 2377,
|
||||||
|
2381, 2383, 2389, 2393, 2399, 2411, 2417, 2423,
|
||||||
|
2437, 2441, 2447, 2459, 2467, 2473, 2477, 2503,
|
||||||
|
2521, 2531, 2539, 2543, 2549, 2551, 2557, 2579,
|
||||||
|
2591, 2593, 2609, 2617, 2621, 2633, 2647, 2657,
|
||||||
|
2659, 2663, 2671, 2677, 2683, 2687, 2689, 2693,
|
||||||
|
2699, 2707, 2711, 2713, 2719, 2729, 2731, 2741,
|
||||||
|
2749, 2753, 2767, 2777, 2789, 2791, 2797, 2801,
|
||||||
|
2803, 2819, 2833, 2837, 2843, 2851, 2857, 2861,
|
||||||
|
2879, 2887, 2897, 2903, 2909, 2917, 2927, 2939,
|
||||||
|
2953, 2957, 2963, 2969, 2971, 2999, 3001, 3011,
|
||||||
|
3019, 3023, 3037, 3041, 3049, 3061, 3067, 3079,
|
||||||
|
3083, 3089, 3109, 3119, 3121, 3137, 3163, 3167,
|
||||||
|
3169, 3181, 3187, 3191, 3203, 3209, 3217, 3221,
|
||||||
|
3229, 3251, 3253, 3257, 3259, 3271, 3299, 3301,
|
||||||
|
3307, 3313, 3319, 3323, 3329, 3331, 3343, 3347,
|
||||||
|
3359, 3361, 3371, 3373, 3389, 3391, 3407, 3413,
|
||||||
|
3433, 3449, 3457, 3461, 3463, 3467, 3469, 3491,
|
||||||
|
3499, 3511, 3517, 3527, 3529, 3533, 3539, 3541,
|
||||||
|
3547, 3557, 3559, 3571, 3581, 3583, 3593, 3607,
|
||||||
|
3613, 3617, 3623, 3631, 3637, 3643, 3659, 3671,
|
||||||
|
3673, 3677, 3691, 3697, 3701, 3709, 3719, 3727,
|
||||||
|
3733, 3739, 3761, 3767, 3769, 3779, 3793, 3797,
|
||||||
|
3803, 3821, 3823, 3833, 3847, 3851, 3853, 3863,
|
||||||
|
3877, 3881, 3889, 3907, 3911, 3917, 3919, 3923,
|
||||||
|
3929, 3931, 3943, 3947, 3967, 3989, 4001, 4003,
|
||||||
|
4007, 4013, 4019, 4021, 4027, 4049, 4051, 4057,
|
||||||
|
4073, 4079, 4091, 4093, 4099, 4111, 4127, 4129,
|
||||||
|
4133, 4139, 4153, 4157, 4159, 4177, 4201, 4211,
|
||||||
|
4217, 4219, 4229, 4231, 4241, 4243, 4253, 4259,
|
||||||
|
4261, 4271, 4273, 4283, 4289, 4297, 4327, 4337,
|
||||||
|
4339, 4349, 4357, 4363, 4373, 4391, 4397, 4409,
|
||||||
|
4421, 4423, 4441, 4447, 4451, 4457, 4463, 4481,
|
||||||
|
4483, 4493, 4507, 4513, 4517, 4519, 4523, 4547,
|
||||||
|
4549, 4561, 4567, 4583, 4591, 4597, 4603, 4621,
|
||||||
|
4637, 4639, 4643, 4649, 4651, 4657, 4663, 4673,
|
||||||
|
4679, 4691, 4703, 4721, 4723, 4729, 4733, 4751,
|
||||||
|
4759, 4783, 4787, 4789, 4793, 4799, 4801, 4813,
|
||||||
|
4817, 4831, 4861, 4871, 4877, 4889, 4903, 4909,
|
||||||
|
4919, 4931, 4933, 4937, 4943, 4951, 4957, 4967,
|
||||||
|
4969, 4973, 4987, 4993, 4999, 5003, 5009, 5011,
|
||||||
|
5021, 5023, 5039, 5051, 5059, 5077, 5081, 5087,
|
||||||
|
5099, 5101, 5107, 5113, 5119, 5147, 5153, 5167,
|
||||||
|
5171, 5179, 5189, 5197, 5209, 5227, 5231, 5233,
|
||||||
|
5237, 5261, 5273, 5279, 5281, 5297, 5303, 5309,
|
||||||
|
5323, 5333, 5347, 5351, 5381, 5387, 5393, 5399,
|
||||||
|
5407, 5413, 5417, 5419, 5431, 5437, 5441, 5443,
|
||||||
|
5449, 5471, 5477, 5479, 5483, 5501, 5503, 5507,
|
||||||
|
5519, 5521, 5527, 5531, 5557, 5563, 5569, 5573,
|
||||||
|
5581, 5591, 5623, 5639, 5641, 5647, 5651, 5653,
|
||||||
|
5657, 5659, 5669, 5683, 5689, 5693, 5701, 5711,
|
||||||
|
5717, 5737, 5741, 5743, 5749, 5779, 5783, 5791,
|
||||||
|
5801, 5807, 5813, 5821, 5827, 5839, 5843, 5849,
|
||||||
|
5851, 5857, 5861, 5867, 5869, 5879, 5881, 5897,
|
||||||
|
5903, 5923, 5927, 5939, 5953, 5981, 5987, 6007,
|
||||||
|
6011, 6029, 6037, 6043, 6047, 6053, 6067, 6073,
|
||||||
|
6079, 6089, 6091, 6101, 6113, 6121, 6131, 6133,
|
||||||
|
6143, 6151, 6163, 6173, 6197, 6199, 6203, 6211,
|
||||||
|
6217, 6221, 6229, 6247, 6257, 6263, 6269, 6271,
|
||||||
|
6277, 6287, 6299, 6301, 6311, 6317, 6323, 6329,
|
||||||
|
6337, 6343, 6353, 6359, 6361, 6367, 6373, 6379,
|
||||||
|
6389, 6397, 6421, 6427, 6449, 6451, 6469, 6473,
|
||||||
|
6481, 6491, 6521, 6529, 6547, 6551, 6553, 6563,
|
||||||
|
6569, 6571, 6577, 6581, 6599, 6607, 6619, 6637,
|
||||||
|
6653, 6659, 6661, 6673, 6679, 6689, 6691, 6701,
|
||||||
|
6703, 6709, 6719, 6733, 6737, 6761, 6763, 6779,
|
||||||
|
6781, 6791, 6793, 6803, 6823, 6827, 6829, 6833,
|
||||||
|
6841, 6857, 6863, 6869, 6871, 6883, 6899, 6907,
|
||||||
|
6911, 6917, 6947, 6949, 6959, 6961, 6967, 6971,
|
||||||
|
6977, 6983, 6991, 6997, 7001, 7013, 7019, 7027,
|
||||||
|
7039, 7043, 7057, 7069, 7079, 7103, 7109, 7121,
|
||||||
|
7127, 7129, 7151, 7159, 7177, 7187, 7193, 7207,
|
||||||
|
7211, 7213, 7219, 7229, 7237, 7243, 7247, 7253,
|
||||||
|
7283, 7297, 7307, 7309, 7321, 7331, 7333, 7349,
|
||||||
|
7351, 7369, 7393, 7411, 7417, 7433, 7451, 7457,
|
||||||
|
7459, 7477, 7481, 7487, 7489, 7499, 7507, 7517,
|
||||||
|
7523, 7529, 7537, 7541, 7547, 7549, 7559, 7561,
|
||||||
|
7573, 7577, 7583, 7589, 7591, 7603, 7607, 7621,
|
||||||
|
7639, 7643, 7649, 7669, 7673, 7681, 7687, 7691,
|
||||||
|
7699, 7703, 7717, 7723, 7727, 7741, 7753, 7757,
|
||||||
|
7759, 7789, 7793, 7817, 7823, 7829, 7841, 7853,
|
||||||
|
7867, 7873, 7877, 7879, 7883, 7901, 7907, 7919,
|
||||||
|
7927, 7933, 7937, 7949, 7951, 7963, 7993, 8009,
|
||||||
|
8011, 8017, 8039, 8053, 8059, 8069, 8081, 8087,
|
||||||
|
8089, 8093, 8101, 8111, 8117, 8123, 8147, 8161,
|
||||||
|
8167, 8171, 8179, 8191, 8209, 8219, 8221, 8231,
|
||||||
|
8233, 8237, 8243, 8263, 8269, 8273, 8287, 8291,
|
||||||
|
8293, 8297, 8311, 8317, 8329, 8353, 8363, 8369,
|
||||||
|
8377, 8387, 8389, 8419, 8423, 8429, 8431, 8443,
|
||||||
|
8447, 8461, 8467, 8501, 8513, 8521, 8527, 8537,
|
||||||
|
8539, 8543, 8563, 8573, 8581, 8597, 8599, 8609,
|
||||||
|
8623, 8627, 8629, 8641, 8647, 8663, 8669, 8677,
|
||||||
|
8681, 8689, 8693, 8699, 8707, 8713, 8719, 8731,
|
||||||
|
8737, 8741, 8747, 8753, 8761, 8779, 8783, 8803,
|
||||||
|
8807, 8819, 8821, 8831, 8837, 8839, 8849, 8861,
|
||||||
|
8863, 8867, 8887, 8893, 8923, 8929, 8933, 8941,
|
||||||
|
8951, 8963, 8969, 8971, 8999, 9001, 9007, 9011,
|
||||||
|
9013, 9029, 9041, 9043, 9049, 9059, 9067, 9091,
|
||||||
|
9103, 9109, 9127, 9133, 9137, 9151, 9157, 9161,
|
||||||
|
9173, 9181, 9187, 9199, 9203, 9209, 9221, 9227,
|
||||||
|
9239, 9241, 9257, 9277, 9281, 9283, 9293, 9311,
|
||||||
|
9319, 9323, 9337, 9341, 9343, 9349, 9371, 9377,
|
||||||
|
9391, 9397, 9403, 9413, 9419, 9421, 9431, 9433,
|
||||||
|
9437, 9439, 9461, 9463, 9467, 9473, 9479, 9491,
|
||||||
|
9497, 9511, 9521, 9533, 9539, 9547, 9551, 9587,
|
||||||
|
9601, 9613, 9619, 9623, 9629, 9631, 9643, 9649,
|
||||||
|
9661, 9677, 9679, 9689, 9697, 9719, 9721, 9733,
|
||||||
|
9739, 9743, 9749, 9767, 9769, 9781, 9787, 9791,
|
||||||
|
9803, 9811, 9817, 9829, 9833, 9839, 9851, 9857,
|
||||||
|
9859, 9871, 9883, 9887, 9901, 9907, 9923, 9929,
|
||||||
|
9931, 9941, 9949, 9967, 9973, 10007, 10009, 10037,
|
||||||
|
10039, 10061, 10067, 10069, 10079, 10091, 10093, 10099,
|
||||||
|
10103, 10111, 10133, 10139, 10141, 10151, 10159, 10163,
|
||||||
|
10169, 10177, 10181, 10193, 10211, 10223, 10243, 10247,
|
||||||
|
10253, 10259, 10267, 10271, 10273, 10289, 10301, 10303,
|
||||||
|
10313, 10321, 10331, 10333, 10337, 10343, 10357, 10369,
|
||||||
|
10391, 10399, 10427, 10429, 10433, 10453, 10457, 10459,
|
||||||
|
10463, 10477, 10487, 10499, 10501, 10513, 10529, 10531,
|
||||||
|
10559, 10567, 10589, 10597, 10601, 10607, 10613, 10627,
|
||||||
|
10631, 10639, 10651, 10657, 10663, 10667, 10687, 10691,
|
||||||
|
10709, 10711, 10723, 10729, 10733, 10739, 10753, 10771,
|
||||||
|
10781, 10789, 10799, 10831, 10837, 10847, 10853, 10859,
|
||||||
|
10861, 10867, 10883, 10889, 10891, 10903, 10909, 10937,
|
||||||
|
10939, 10949, 10957, 10973, 10979, 10987, 10993, 11003,
|
||||||
|
11027, 11047, 11057, 11059, 11069, 11071, 11083, 11087,
|
||||||
|
11093, 11113, 11117, 11119, 11131, 11149, 11159, 11161,
|
||||||
|
11171, 11173, 11177, 11197, 11213, 11239, 11243, 11251,
|
||||||
|
11257, 11261, 11273, 11279, 11287, 11299, 11311, 11317,
|
||||||
|
11321, 11329, 11351, 11353, 11369, 11383, 11393, 11399,
|
||||||
|
11411, 11423, 11437, 11443, 11447, 11467, 11471, 11483,
|
||||||
|
11489, 11491, 11497, 11503, 11519, 11527, 11549, 11551,
|
||||||
|
11579, 11587, 11593, 11597, 11617, 11621, 11633, 11657,
|
||||||
|
11677, 11681, 11689, 11699, 11701, 11717, 11719, 11731,
|
||||||
|
11743, 11777, 11779, 11783, 11789, 11801, 11807, 11813,
|
||||||
|
11821, 11827, 11831, 11833, 11839, 11863, 11867, 11887,
|
||||||
|
11897, 11903, 11909, 11923, 11927, 11933, 11939, 11941,
|
||||||
|
11953, 11959, 11969, 11971, 11981, 11987, 12007, 12011,
|
||||||
|
12037, 12041, 12043, 12049, 12071, 12073, 12097, 12101,
|
||||||
|
12107, 12109, 12113, 12119, 12143, 12149, 12157, 12161,
|
||||||
|
12163, 12197, 12203, 12211, 12227, 12239, 12241, 12251,
|
||||||
|
12253, 12263, 12269, 12277, 12281, 12289, 12301, 12323,
|
||||||
|
12329, 12343, 12347, 12373, 12377, 12379, 12391, 12401,
|
||||||
|
12409, 12413, 12421, 12433, 12437, 12451, 12457, 12473,
|
||||||
|
12479, 12487, 12491, 12497, 12503, 12511, 12517, 12527,
|
||||||
|
12539, 12541, 12547, 12553, 12569, 12577, 12583, 12589,
|
||||||
|
12601, 12611, 12613, 12619, 12637, 12641, 12647, 12653,
|
||||||
|
12659, 12671, 12689, 12697, 12703, 12713, 12721, 12739,
|
||||||
|
12743, 12757, 12763, 12781, 12791, 12799, 12809, 12821,
|
||||||
|
12823, 12829, 12841, 12853, 12889, 12893, 12899, 12907,
|
||||||
|
12911, 12917, 12919, 12923, 12941, 12953, 12959, 12967,
|
||||||
|
12973, 12979, 12983, 13001, 13003, 13007, 13009, 13033,
|
||||||
|
13037, 13043, 13049, 13063, 13093, 13099, 13103, 13109,
|
||||||
|
13121, 13127, 13147, 13151, 13159, 13163, 13171, 13177,
|
||||||
|
13183, 13187, 13217, 13219, 13229, 13241, 13249, 13259,
|
||||||
|
13267, 13291, 13297, 13309, 13313, 13327, 13331, 13337,
|
||||||
|
13339, 13367, 13381, 13397, 13399, 13411, 13417, 13421,
|
||||||
|
13441, 13451, 13457, 13463, 13469, 13477, 13487, 13499,
|
||||||
|
13513, 13523, 13537, 13553, 13567, 13577, 13591, 13597,
|
||||||
|
13613, 13619, 13627, 13633, 13649, 13669, 13679, 13681,
|
||||||
|
13687, 13691, 13693, 13697, 13709, 13711, 13721, 13723,
|
||||||
|
13729, 13751, 13757, 13759, 13763, 13781, 13789, 13799,
|
||||||
|
13807, 13829, 13831, 13841, 13859, 13873, 13877, 13879,
|
||||||
|
13883, 13901, 13903, 13907, 13913, 13921, 13931, 13933,
|
||||||
|
13963, 13967, 13997, 13999, 14009, 14011, 14029, 14033,
|
||||||
|
14051, 14057, 14071, 14081, 14083, 14087, 14107, 14143,
|
||||||
|
14149, 14153, 14159, 14173, 14177, 14197, 14207, 14221,
|
||||||
|
14243, 14249, 14251, 14281, 14293, 14303, 14321, 14323,
|
||||||
|
14327, 14341, 14347, 14369, 14387, 14389, 14401, 14407,
|
||||||
|
14411, 14419, 14423, 14431, 14437, 14447, 14449, 14461,
|
||||||
|
14479, 14489, 14503, 14519, 14533, 14537, 14543, 14549,
|
||||||
|
14551, 14557, 14561, 14563, 14591, 14593, 14621, 14627,
|
||||||
|
14629, 14633, 14639, 14653, 14657, 14669, 14683, 14699,
|
||||||
|
14713, 14717, 14723, 14731, 14737, 14741, 14747, 14753,
|
||||||
|
14759, 14767, 14771, 14779, 14783, 14797, 14813, 14821,
|
||||||
|
14827, 14831, 14843, 14851, 14867, 14869, 14879, 14887,
|
||||||
|
14891, 14897, 14923, 14929, 14939, 14947, 14951, 14957,
|
||||||
|
14969, 14983, 15013, 15017, 15031, 15053, 15061, 15073,
|
||||||
|
15077, 15083, 15091, 15101, 15107, 15121, 15131, 15137,
|
||||||
|
15139, 15149, 15161, 15173, 15187, 15193, 15199, 15217,
|
||||||
|
15227, 15233, 15241, 15259, 15263, 15269, 15271, 15277,
|
||||||
|
15287, 15289, 15299, 15307, 15313, 15319, 15329, 15331,
|
||||||
|
15349, 15359, 15361, 15373, 15377, 15383, 15391, 15401,
|
||||||
|
15413, 15427, 15439, 15443, 15451, 15461, 15467, 15473,
|
||||||
|
15493, 15497, 15511, 15527, 15541, 15551, 15559, 15569,
|
||||||
|
15581, 15583, 15601, 15607, 15619, 15629, 15641, 15643,
|
||||||
|
15647, 15649, 15661, 15667, 15671, 15679, 15683, 15727,
|
||||||
|
15731, 15733, 15737, 15739, 15749, 15761, 15767, 15773,
|
||||||
|
15787, 15791, 15797, 15803, 15809, 15817, 15823, 15859,
|
||||||
|
15877, 15881, 15887, 15889, 15901, 15907, 15913, 15919,
|
||||||
|
15923, 15937, 15959, 15971, 15973, 15991, 16001, 16007,
|
||||||
|
16033, 16057, 16061, 16063, 16067, 16069, 16073, 16087,
|
||||||
|
16091, 16097, 16103, 16111, 16127, 16139, 16141, 16183,
|
||||||
|
16187, 16189, 16193, 16217, 16223, 16229, 16231, 16249,
|
||||||
|
16253, 16267, 16273, 16301, 16319, 16333, 16339, 16349,
|
||||||
|
16361, 16363, 16369, 16381, 16411, 16417, 16421, 16427,
|
||||||
|
16433, 16447, 16451, 16453, 16477, 16481, 16487, 16493,
|
||||||
|
16519, 16529, 16547, 16553, 16561, 16567, 16573, 16603,
|
||||||
|
16607, 16619, 16631, 16633, 16649, 16651, 16657, 16661,
|
||||||
|
16673, 16691, 16693, 16699, 16703, 16729, 16741, 16747,
|
||||||
|
16759, 16763, 16787, 16811, 16823, 16829, 16831, 16843,
|
||||||
|
16871, 16879, 16883, 16889, 16901, 16903, 16921, 16927,
|
||||||
|
16931, 16937, 16943, 16963, 16979, 16981, 16987, 16993,
|
||||||
|
17011, 17021, 17027, 17029, 17033, 17041, 17047, 17053,
|
||||||
|
17077, 17093, 17099, 17107, 17117, 17123, 17137, 17159,
|
||||||
|
17167, 17183, 17189, 17191, 17203, 17207, 17209, 17231,
|
||||||
|
17239, 17257, 17291, 17293, 17299, 17317, 17321, 17327,
|
||||||
|
17333, 17341, 17351, 17359, 17377, 17383, 17387, 17389,
|
||||||
|
17393, 17401, 17417, 17419, 17431, 17443, 17449, 17467,
|
||||||
|
17471, 17477, 17483, 17489, 17491, 17497, 17509, 17519,
|
||||||
|
17539, 17551, 17569, 17573, 17579, 17581, 17597, 17599,
|
||||||
|
17609, 17623, 17627, 17657, 17659, 17669, 17681, 17683,
|
||||||
|
17707, 17713, 17729, 17737, 17747, 17749, 17761, 17783,
|
||||||
|
17789, 17791, 17807, 17827, 17837, 17839, 17851, 17863,
|
||||||
|
}
|
104
vendor/github.com/Luzifer/go-dhparam/validate.go
generated
vendored
Normal file
104
vendor/github.com/Luzifer/go-dhparam/validate.go
generated
vendored
Normal file
|
@ -0,0 +1,104 @@
|
||||||
|
package dhparam
|
||||||
|
|
||||||
|
import (
|
||||||
|
"math/big"
|
||||||
|
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
const dhCheckPNotPrime = 0x01
|
||||||
|
const dhCheckPNotSafePrime = 0x02
|
||||||
|
const dhUnableToCheckGenerator = 0x04
|
||||||
|
const dhNotSuitableGenerator = 0x08
|
||||||
|
const dhCheckQNotPrime = 0x10
|
||||||
|
const dhCheckInvalidQValue = 0x20
|
||||||
|
const dhCheckInvalidJValue = 0x40
|
||||||
|
|
||||||
|
// ErrAllParametersOK is defined to check whether the returned error from Check is indeed no error
|
||||||
|
// For simplicity reasons it is defined as an error instead of an additional result parameter
|
||||||
|
var ErrAllParametersOK = errors.New("DH parameters appear to be ok")
|
||||||
|
|
||||||
|
// Check returns a number of errors and an "ok" bool. If the "ok" bool is set to true, still one
|
||||||
|
// error is returned: ErrAllParametersOK. If "ok" is false, the error list will contain at least
|
||||||
|
// one error not being equal to ErrAllParametersOK.
|
||||||
|
func (d DH) Check() ([]error, bool) {
|
||||||
|
var (
|
||||||
|
result = []error{}
|
||||||
|
ok = true
|
||||||
|
)
|
||||||
|
|
||||||
|
i := d.check()
|
||||||
|
|
||||||
|
if i&dhCheckPNotPrime > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: p value is not prime"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i&dhCheckPNotSafePrime > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: p value is not a safe prime"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i&dhCheckQNotPrime > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: q value is not a prime"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i&dhCheckInvalidQValue > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: q value is invalid"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i&dhCheckInvalidJValue > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: j value is invalid"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i&dhUnableToCheckGenerator > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: unable to check the generator value"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i&dhNotSuitableGenerator > 0 {
|
||||||
|
result = append(result, errors.New("WARNING: the g value is not a generator"))
|
||||||
|
ok = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if i == 0 {
|
||||||
|
result = append(result, ErrAllParametersOK)
|
||||||
|
}
|
||||||
|
|
||||||
|
return result, ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d DH) check() int {
|
||||||
|
var ret int
|
||||||
|
|
||||||
|
// Check generator
|
||||||
|
switch d.G {
|
||||||
|
case 2:
|
||||||
|
l := new(big.Int)
|
||||||
|
if l.Mod(d.P, big.NewInt(24)); l.Int64() != 11 {
|
||||||
|
ret |= dhNotSuitableGenerator
|
||||||
|
}
|
||||||
|
case 5:
|
||||||
|
l := new(big.Int)
|
||||||
|
if l.Mod(d.P, big.NewInt(10)); l.Int64() != 3 && l.Int64() != 7 {
|
||||||
|
ret |= dhNotSuitableGenerator
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
ret |= dhUnableToCheckGenerator
|
||||||
|
}
|
||||||
|
|
||||||
|
if !d.P.ProbablyPrime(1) {
|
||||||
|
ret |= dhCheckPNotPrime
|
||||||
|
} else {
|
||||||
|
t1 := new(big.Int)
|
||||||
|
t1.Rsh(d.P, 1)
|
||||||
|
if !t1.ProbablyPrime(1) {
|
||||||
|
ret |= dhCheckPNotSafePrime
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ret
|
||||||
|
}
|
5
vendor/github.com/fsnotify/fsnotify/.editorconfig
generated
vendored
5
vendor/github.com/fsnotify/fsnotify/.editorconfig
generated
vendored
|
@ -1,5 +0,0 @@
|
||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
indent_style = tab
|
|
||||||
indent_size = 4
|
|
6
vendor/github.com/fsnotify/fsnotify/.gitignore
generated
vendored
6
vendor/github.com/fsnotify/fsnotify/.gitignore
generated
vendored
|
@ -1,6 +0,0 @@
|
||||||
# Setup a Global .gitignore for OS and editor generated files:
|
|
||||||
# https://help.github.com/articles/ignoring-files
|
|
||||||
# git config --global core.excludesfile ~/.gitignore_global
|
|
||||||
|
|
||||||
.vagrant
|
|
||||||
*.sublime-project
|
|
30
vendor/github.com/fsnotify/fsnotify/.travis.yml
generated
vendored
30
vendor/github.com/fsnotify/fsnotify/.travis.yml
generated
vendored
|
@ -1,30 +0,0 @@
|
||||||
sudo: false
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.8.x
|
|
||||||
- 1.9.x
|
|
||||||
- tip
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
fast_finish: true
|
|
||||||
|
|
||||||
before_script:
|
|
||||||
- go get -u github.com/golang/lint/golint
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go test -v --race ./...
|
|
||||||
|
|
||||||
after_script:
|
|
||||||
- test -z "$(gofmt -s -l -w . | tee /dev/stderr)"
|
|
||||||
- test -z "$(golint ./... | tee /dev/stderr)"
|
|
||||||
- go vet ./...
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
email: false
|
|
317
vendor/github.com/fsnotify/fsnotify/CHANGELOG.md
generated
vendored
317
vendor/github.com/fsnotify/fsnotify/CHANGELOG.md
generated
vendored
|
@ -1,317 +0,0 @@
|
||||||
# Changelog
|
|
||||||
|
|
||||||
## v1.4.7 / 2018-01-09
|
|
||||||
|
|
||||||
* BSD/macOS: Fix possible deadlock on closing the watcher on kqueue (thanks @nhooyr and @glycerine)
|
|
||||||
* Tests: Fix missing verb on format string (thanks @rchiossi)
|
|
||||||
* Linux: Fix deadlock in Remove (thanks @aarondl)
|
|
||||||
* Linux: Watch.Add improvements (avoid race, fix consistency, reduce garbage) (thanks @twpayne)
|
|
||||||
* Docs: Moved FAQ into the README (thanks @vahe)
|
|
||||||
* Linux: Properly handle inotify's IN_Q_OVERFLOW event (thanks @zeldovich)
|
|
||||||
* Docs: replace references to OS X with macOS
|
|
||||||
|
|
||||||
## v1.4.2 / 2016-10-10
|
|
||||||
|
|
||||||
* Linux: use InotifyInit1 with IN_CLOEXEC to stop leaking a file descriptor to a child process when using fork/exec [#178](https://github.com/fsnotify/fsnotify/pull/178) (thanks @pattyshack)
|
|
||||||
|
|
||||||
## v1.4.1 / 2016-10-04
|
|
||||||
|
|
||||||
* Fix flaky inotify stress test on Linux [#177](https://github.com/fsnotify/fsnotify/pull/177) (thanks @pattyshack)
|
|
||||||
|
|
||||||
## v1.4.0 / 2016-10-01
|
|
||||||
|
|
||||||
* add a String() method to Event.Op [#165](https://github.com/fsnotify/fsnotify/pull/165) (thanks @oozie)
|
|
||||||
|
|
||||||
## v1.3.1 / 2016-06-28
|
|
||||||
|
|
||||||
* Windows: fix for double backslash when watching the root of a drive [#151](https://github.com/fsnotify/fsnotify/issues/151) (thanks @brunoqc)
|
|
||||||
|
|
||||||
## v1.3.0 / 2016-04-19
|
|
||||||
|
|
||||||
* Support linux/arm64 by [patching](https://go-review.googlesource.com/#/c/21971/) x/sys/unix and switching to to it from syscall (thanks @suihkulokki) [#135](https://github.com/fsnotify/fsnotify/pull/135)
|
|
||||||
|
|
||||||
## v1.2.10 / 2016-03-02
|
|
||||||
|
|
||||||
* Fix golint errors in windows.go [#121](https://github.com/fsnotify/fsnotify/pull/121) (thanks @tiffanyfj)
|
|
||||||
|
|
||||||
## v1.2.9 / 2016-01-13
|
|
||||||
|
|
||||||
kqueue: Fix logic for CREATE after REMOVE [#111](https://github.com/fsnotify/fsnotify/pull/111) (thanks @bep)
|
|
||||||
|
|
||||||
## v1.2.8 / 2015-12-17
|
|
||||||
|
|
||||||
* kqueue: fix race condition in Close [#105](https://github.com/fsnotify/fsnotify/pull/105) (thanks @djui for reporting the issue and @ppknap for writing a failing test)
|
|
||||||
* inotify: fix race in test
|
|
||||||
* enable race detection for continuous integration (Linux, Mac, Windows)
|
|
||||||
|
|
||||||
## v1.2.5 / 2015-10-17
|
|
||||||
|
|
||||||
* inotify: use epoll_create1 for arm64 support (requires Linux 2.6.27 or later) [#100](https://github.com/fsnotify/fsnotify/pull/100) (thanks @suihkulokki)
|
|
||||||
* inotify: fix path leaks [#73](https://github.com/fsnotify/fsnotify/pull/73) (thanks @chamaken)
|
|
||||||
* kqueue: watch for rename events on subdirectories [#83](https://github.com/fsnotify/fsnotify/pull/83) (thanks @guotie)
|
|
||||||
* kqueue: avoid infinite loops from symlinks cycles [#101](https://github.com/fsnotify/fsnotify/pull/101) (thanks @illicitonion)
|
|
||||||
|
|
||||||
## v1.2.1 / 2015-10-14
|
|
||||||
|
|
||||||
* kqueue: don't watch named pipes [#98](https://github.com/fsnotify/fsnotify/pull/98) (thanks @evanphx)
|
|
||||||
|
|
||||||
## v1.2.0 / 2015-02-08
|
|
||||||
|
|
||||||
* inotify: use epoll to wake up readEvents [#66](https://github.com/fsnotify/fsnotify/pull/66) (thanks @PieterD)
|
|
||||||
* inotify: closing watcher should now always shut down goroutine [#63](https://github.com/fsnotify/fsnotify/pull/63) (thanks @PieterD)
|
|
||||||
* kqueue: close kqueue after removing watches, fixes [#59](https://github.com/fsnotify/fsnotify/issues/59)
|
|
||||||
|
|
||||||
## v1.1.1 / 2015-02-05
|
|
||||||
|
|
||||||
* inotify: Retry read on EINTR [#61](https://github.com/fsnotify/fsnotify/issues/61) (thanks @PieterD)
|
|
||||||
|
|
||||||
## v1.1.0 / 2014-12-12
|
|
||||||
|
|
||||||
* kqueue: rework internals [#43](https://github.com/fsnotify/fsnotify/pull/43)
|
|
||||||
* add low-level functions
|
|
||||||
* only need to store flags on directories
|
|
||||||
* less mutexes [#13](https://github.com/fsnotify/fsnotify/issues/13)
|
|
||||||
* done can be an unbuffered channel
|
|
||||||
* remove calls to os.NewSyscallError
|
|
||||||
* More efficient string concatenation for Event.String() [#52](https://github.com/fsnotify/fsnotify/pull/52) (thanks @mdlayher)
|
|
||||||
* kqueue: fix regression in rework causing subdirectories to be watched [#48](https://github.com/fsnotify/fsnotify/issues/48)
|
|
||||||
* kqueue: cleanup internal watch before sending remove event [#51](https://github.com/fsnotify/fsnotify/issues/51)
|
|
||||||
|
|
||||||
## v1.0.4 / 2014-09-07
|
|
||||||
|
|
||||||
* kqueue: add dragonfly to the build tags.
|
|
||||||
* Rename source code files, rearrange code so exported APIs are at the top.
|
|
||||||
* Add done channel to example code. [#37](https://github.com/fsnotify/fsnotify/pull/37) (thanks @chenyukang)
|
|
||||||
|
|
||||||
## v1.0.3 / 2014-08-19
|
|
||||||
|
|
||||||
* [Fix] Windows MOVED_TO now translates to Create like on BSD and Linux. [#36](https://github.com/fsnotify/fsnotify/issues/36)
|
|
||||||
|
|
||||||
## v1.0.2 / 2014-08-17
|
|
||||||
|
|
||||||
* [Fix] Missing create events on macOS. [#14](https://github.com/fsnotify/fsnotify/issues/14) (thanks @zhsso)
|
|
||||||
* [Fix] Make ./path and path equivalent. (thanks @zhsso)
|
|
||||||
|
|
||||||
## v1.0.0 / 2014-08-15
|
|
||||||
|
|
||||||
* [API] Remove AddWatch on Windows, use Add.
|
|
||||||
* Improve documentation for exported identifiers. [#30](https://github.com/fsnotify/fsnotify/issues/30)
|
|
||||||
* Minor updates based on feedback from golint.
|
|
||||||
|
|
||||||
## dev / 2014-07-09
|
|
||||||
|
|
||||||
* Moved to [github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify).
|
|
||||||
* Use os.NewSyscallError instead of returning errno (thanks @hariharan-uno)
|
|
||||||
|
|
||||||
## dev / 2014-07-04
|
|
||||||
|
|
||||||
* kqueue: fix incorrect mutex used in Close()
|
|
||||||
* Update example to demonstrate usage of Op.
|
|
||||||
|
|
||||||
## dev / 2014-06-28
|
|
||||||
|
|
||||||
* [API] Don't set the Write Op for attribute notifications [#4](https://github.com/fsnotify/fsnotify/issues/4)
|
|
||||||
* Fix for String() method on Event (thanks Alex Brainman)
|
|
||||||
* Don't build on Plan 9 or Solaris (thanks @4ad)
|
|
||||||
|
|
||||||
## dev / 2014-06-21
|
|
||||||
|
|
||||||
* Events channel of type Event rather than *Event.
|
|
||||||
* [internal] use syscall constants directly for inotify and kqueue.
|
|
||||||
* [internal] kqueue: rename events to kevents and fileEvent to event.
|
|
||||||
|
|
||||||
## dev / 2014-06-19
|
|
||||||
|
|
||||||
* Go 1.3+ required on Windows (uses syscall.ERROR_MORE_DATA internally).
|
|
||||||
* [internal] remove cookie from Event struct (unused).
|
|
||||||
* [internal] Event struct has the same definition across every OS.
|
|
||||||
* [internal] remove internal watch and removeWatch methods.
|
|
||||||
|
|
||||||
## dev / 2014-06-12
|
|
||||||
|
|
||||||
* [API] Renamed Watch() to Add() and RemoveWatch() to Remove().
|
|
||||||
* [API] Pluralized channel names: Events and Errors.
|
|
||||||
* [API] Renamed FileEvent struct to Event.
|
|
||||||
* [API] Op constants replace methods like IsCreate().
|
|
||||||
|
|
||||||
## dev / 2014-06-12
|
|
||||||
|
|
||||||
* Fix data race on kevent buffer (thanks @tilaks) [#98](https://github.com/howeyc/fsnotify/pull/98)
|
|
||||||
|
|
||||||
## dev / 2014-05-23
|
|
||||||
|
|
||||||
* [API] Remove current implementation of WatchFlags.
|
|
||||||
* current implementation doesn't take advantage of OS for efficiency
|
|
||||||
* provides little benefit over filtering events as they are received, but has extra bookkeeping and mutexes
|
|
||||||
* no tests for the current implementation
|
|
||||||
* not fully implemented on Windows [#93](https://github.com/howeyc/fsnotify/issues/93#issuecomment-39285195)
|
|
||||||
|
|
||||||
## v0.9.3 / 2014-12-31
|
|
||||||
|
|
||||||
* kqueue: cleanup internal watch before sending remove event [#51](https://github.com/fsnotify/fsnotify/issues/51)
|
|
||||||
|
|
||||||
## v0.9.2 / 2014-08-17
|
|
||||||
|
|
||||||
* [Backport] Fix missing create events on macOS. [#14](https://github.com/fsnotify/fsnotify/issues/14) (thanks @zhsso)
|
|
||||||
|
|
||||||
## v0.9.1 / 2014-06-12
|
|
||||||
|
|
||||||
* Fix data race on kevent buffer (thanks @tilaks) [#98](https://github.com/howeyc/fsnotify/pull/98)
|
|
||||||
|
|
||||||
## v0.9.0 / 2014-01-17
|
|
||||||
|
|
||||||
* IsAttrib() for events that only concern a file's metadata [#79][] (thanks @abustany)
|
|
||||||
* [Fix] kqueue: fix deadlock [#77][] (thanks @cespare)
|
|
||||||
* [NOTICE] Development has moved to `code.google.com/p/go.exp/fsnotify` in preparation for inclusion in the Go standard library.
|
|
||||||
|
|
||||||
## v0.8.12 / 2013-11-13
|
|
||||||
|
|
||||||
* [API] Remove FD_SET and friends from Linux adapter
|
|
||||||
|
|
||||||
## v0.8.11 / 2013-11-02
|
|
||||||
|
|
||||||
* [Doc] Add Changelog [#72][] (thanks @nathany)
|
|
||||||
* [Doc] Spotlight and double modify events on macOS [#62][] (reported by @paulhammond)
|
|
||||||
|
|
||||||
## v0.8.10 / 2013-10-19
|
|
||||||
|
|
||||||
* [Fix] kqueue: remove file watches when parent directory is removed [#71][] (reported by @mdwhatcott)
|
|
||||||
* [Fix] kqueue: race between Close and readEvents [#70][] (reported by @bernerdschaefer)
|
|
||||||
* [Doc] specify OS-specific limits in README (thanks @debrando)
|
|
||||||
|
|
||||||
## v0.8.9 / 2013-09-08
|
|
||||||
|
|
||||||
* [Doc] Contributing (thanks @nathany)
|
|
||||||
* [Doc] update package path in example code [#63][] (thanks @paulhammond)
|
|
||||||
* [Doc] GoCI badge in README (Linux only) [#60][]
|
|
||||||
* [Doc] Cross-platform testing with Vagrant [#59][] (thanks @nathany)
|
|
||||||
|
|
||||||
## v0.8.8 / 2013-06-17
|
|
||||||
|
|
||||||
* [Fix] Windows: handle `ERROR_MORE_DATA` on Windows [#49][] (thanks @jbowtie)
|
|
||||||
|
|
||||||
## v0.8.7 / 2013-06-03
|
|
||||||
|
|
||||||
* [API] Make syscall flags internal
|
|
||||||
* [Fix] inotify: ignore event changes
|
|
||||||
* [Fix] race in symlink test [#45][] (reported by @srid)
|
|
||||||
* [Fix] tests on Windows
|
|
||||||
* lower case error messages
|
|
||||||
|
|
||||||
## v0.8.6 / 2013-05-23
|
|
||||||
|
|
||||||
* kqueue: Use EVT_ONLY flag on Darwin
|
|
||||||
* [Doc] Update README with full example
|
|
||||||
|
|
||||||
## v0.8.5 / 2013-05-09
|
|
||||||
|
|
||||||
* [Fix] inotify: allow monitoring of "broken" symlinks (thanks @tsg)
|
|
||||||
|
|
||||||
## v0.8.4 / 2013-04-07
|
|
||||||
|
|
||||||
* [Fix] kqueue: watch all file events [#40][] (thanks @ChrisBuchholz)
|
|
||||||
|
|
||||||
## v0.8.3 / 2013-03-13
|
|
||||||
|
|
||||||
* [Fix] inoitfy/kqueue memory leak [#36][] (reported by @nbkolchin)
|
|
||||||
* [Fix] kqueue: use fsnFlags for watching a directory [#33][] (reported by @nbkolchin)
|
|
||||||
|
|
||||||
## v0.8.2 / 2013-02-07
|
|
||||||
|
|
||||||
* [Doc] add Authors
|
|
||||||
* [Fix] fix data races for map access [#29][] (thanks @fsouza)
|
|
||||||
|
|
||||||
## v0.8.1 / 2013-01-09
|
|
||||||
|
|
||||||
* [Fix] Windows path separators
|
|
||||||
* [Doc] BSD License
|
|
||||||
|
|
||||||
## v0.8.0 / 2012-11-09
|
|
||||||
|
|
||||||
* kqueue: directory watching improvements (thanks @vmirage)
|
|
||||||
* inotify: add `IN_MOVED_TO` [#25][] (requested by @cpisto)
|
|
||||||
* [Fix] kqueue: deleting watched directory [#24][] (reported by @jakerr)
|
|
||||||
|
|
||||||
## v0.7.4 / 2012-10-09
|
|
||||||
|
|
||||||
* [Fix] inotify: fixes from https://codereview.appspot.com/5418045/ (ugorji)
|
|
||||||
* [Fix] kqueue: preserve watch flags when watching for delete [#21][] (reported by @robfig)
|
|
||||||
* [Fix] kqueue: watch the directory even if it isn't a new watch (thanks @robfig)
|
|
||||||
* [Fix] kqueue: modify after recreation of file
|
|
||||||
|
|
||||||
## v0.7.3 / 2012-09-27
|
|
||||||
|
|
||||||
* [Fix] kqueue: watch with an existing folder inside the watched folder (thanks @vmirage)
|
|
||||||
* [Fix] kqueue: no longer get duplicate CREATE events
|
|
||||||
|
|
||||||
## v0.7.2 / 2012-09-01
|
|
||||||
|
|
||||||
* kqueue: events for created directories
|
|
||||||
|
|
||||||
## v0.7.1 / 2012-07-14
|
|
||||||
|
|
||||||
* [Fix] for renaming files
|
|
||||||
|
|
||||||
## v0.7.0 / 2012-07-02
|
|
||||||
|
|
||||||
* [Feature] FSNotify flags
|
|
||||||
* [Fix] inotify: Added file name back to event path
|
|
||||||
|
|
||||||
## v0.6.0 / 2012-06-06
|
|
||||||
|
|
||||||
* kqueue: watch files after directory created (thanks @tmc)
|
|
||||||
|
|
||||||
## v0.5.1 / 2012-05-22
|
|
||||||
|
|
||||||
* [Fix] inotify: remove all watches before Close()
|
|
||||||
|
|
||||||
## v0.5.0 / 2012-05-03
|
|
||||||
|
|
||||||
* [API] kqueue: return errors during watch instead of sending over channel
|
|
||||||
* kqueue: match symlink behavior on Linux
|
|
||||||
* inotify: add `DELETE_SELF` (requested by @taralx)
|
|
||||||
* [Fix] kqueue: handle EINTR (reported by @robfig)
|
|
||||||
* [Doc] Godoc example [#1][] (thanks @davecheney)
|
|
||||||
|
|
||||||
## v0.4.0 / 2012-03-30
|
|
||||||
|
|
||||||
* Go 1 released: build with go tool
|
|
||||||
* [Feature] Windows support using winfsnotify
|
|
||||||
* Windows does not have attribute change notifications
|
|
||||||
* Roll attribute notifications into IsModify
|
|
||||||
|
|
||||||
## v0.3.0 / 2012-02-19
|
|
||||||
|
|
||||||
* kqueue: add files when watch directory
|
|
||||||
|
|
||||||
## v0.2.0 / 2011-12-30
|
|
||||||
|
|
||||||
* update to latest Go weekly code
|
|
||||||
|
|
||||||
## v0.1.0 / 2011-10-19
|
|
||||||
|
|
||||||
* kqueue: add watch on file creation to match inotify
|
|
||||||
* kqueue: create file event
|
|
||||||
* inotify: ignore `IN_IGNORED` events
|
|
||||||
* event String()
|
|
||||||
* linux: common FileEvent functions
|
|
||||||
* initial commit
|
|
||||||
|
|
||||||
[#79]: https://github.com/howeyc/fsnotify/pull/79
|
|
||||||
[#77]: https://github.com/howeyc/fsnotify/pull/77
|
|
||||||
[#72]: https://github.com/howeyc/fsnotify/issues/72
|
|
||||||
[#71]: https://github.com/howeyc/fsnotify/issues/71
|
|
||||||
[#70]: https://github.com/howeyc/fsnotify/issues/70
|
|
||||||
[#63]: https://github.com/howeyc/fsnotify/issues/63
|
|
||||||
[#62]: https://github.com/howeyc/fsnotify/issues/62
|
|
||||||
[#60]: https://github.com/howeyc/fsnotify/issues/60
|
|
||||||
[#59]: https://github.com/howeyc/fsnotify/issues/59
|
|
||||||
[#49]: https://github.com/howeyc/fsnotify/issues/49
|
|
||||||
[#45]: https://github.com/howeyc/fsnotify/issues/45
|
|
||||||
[#40]: https://github.com/howeyc/fsnotify/issues/40
|
|
||||||
[#36]: https://github.com/howeyc/fsnotify/issues/36
|
|
||||||
[#33]: https://github.com/howeyc/fsnotify/issues/33
|
|
||||||
[#29]: https://github.com/howeyc/fsnotify/issues/29
|
|
||||||
[#25]: https://github.com/howeyc/fsnotify/issues/25
|
|
||||||
[#24]: https://github.com/howeyc/fsnotify/issues/24
|
|
||||||
[#21]: https://github.com/howeyc/fsnotify/issues/21
|
|
77
vendor/github.com/fsnotify/fsnotify/CONTRIBUTING.md
generated
vendored
77
vendor/github.com/fsnotify/fsnotify/CONTRIBUTING.md
generated
vendored
|
@ -1,77 +0,0 @@
|
||||||
# Contributing
|
|
||||||
|
|
||||||
## Issues
|
|
||||||
|
|
||||||
* Request features and report bugs using the [GitHub Issue Tracker](https://github.com/fsnotify/fsnotify/issues).
|
|
||||||
* Please indicate the platform you are using fsnotify on.
|
|
||||||
* A code example to reproduce the problem is appreciated.
|
|
||||||
|
|
||||||
## Pull Requests
|
|
||||||
|
|
||||||
### Contributor License Agreement
|
|
||||||
|
|
||||||
fsnotify is derived from code in the [golang.org/x/exp](https://godoc.org/golang.org/x/exp) package and it may be included [in the standard library](https://github.com/fsnotify/fsnotify/issues/1) in the future. Therefore fsnotify carries the same [LICENSE](https://github.com/fsnotify/fsnotify/blob/master/LICENSE) as Go. Contributors retain their copyright, so you need to fill out a short form before we can accept your contribution: [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual).
|
|
||||||
|
|
||||||
Please indicate that you have signed the CLA in your pull request.
|
|
||||||
|
|
||||||
### How fsnotify is Developed
|
|
||||||
|
|
||||||
* Development is done on feature branches.
|
|
||||||
* Tests are run on BSD, Linux, macOS and Windows.
|
|
||||||
* Pull requests are reviewed and [applied to master][am] using [hub][].
|
|
||||||
* Maintainers may modify or squash commits rather than asking contributors to.
|
|
||||||
* To issue a new release, the maintainers will:
|
|
||||||
* Update the CHANGELOG
|
|
||||||
* Tag a version, which will become available through gopkg.in.
|
|
||||||
|
|
||||||
### How to Fork
|
|
||||||
|
|
||||||
For smooth sailing, always use the original import path. Installing with `go get` makes this easy.
|
|
||||||
|
|
||||||
1. Install from GitHub (`go get -u github.com/fsnotify/fsnotify`)
|
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Ensure everything works and the tests pass (see below)
|
|
||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
|
|
||||||
Contribute upstream:
|
|
||||||
|
|
||||||
1. Fork fsnotify on GitHub
|
|
||||||
2. Add your remote (`git remote add fork git@github.com:mycompany/repo.git`)
|
|
||||||
3. Push to the branch (`git push fork my-new-feature`)
|
|
||||||
4. Create a new Pull Request on GitHub
|
|
||||||
|
|
||||||
This workflow is [thoroughly explained by Katrina Owen](https://splice.com/blog/contributing-open-source-git-repositories-go/).
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
fsnotify uses build tags to compile different code on Linux, BSD, macOS, and Windows.
|
|
||||||
|
|
||||||
Before doing a pull request, please do your best to test your changes on multiple platforms, and list which platforms you were able/unable to test on.
|
|
||||||
|
|
||||||
To aid in cross-platform testing there is a Vagrantfile for Linux and BSD.
|
|
||||||
|
|
||||||
* Install [Vagrant](http://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/)
|
|
||||||
* Setup [Vagrant Gopher](https://github.com/nathany/vagrant-gopher) in your `src` folder.
|
|
||||||
* Run `vagrant up` from the project folder. You can also setup just one box with `vagrant up linux` or `vagrant up bsd` (note: the BSD box doesn't support Windows hosts at this time, and NFS may prompt for your host OS password)
|
|
||||||
* Once setup, you can run the test suite on a given OS with a single command `vagrant ssh linux -c 'cd fsnotify/fsnotify; go test'`.
|
|
||||||
* When you're done, you will want to halt or destroy the Vagrant boxes.
|
|
||||||
|
|
||||||
Notice: fsnotify file system events won't trigger in shared folders. The tests get around this limitation by using the /tmp directory.
|
|
||||||
|
|
||||||
Right now there is no equivalent solution for Windows and macOS, but there are Windows VMs [freely available from Microsoft](http://www.modern.ie/en-us/virtualization-tools#downloads).
|
|
||||||
|
|
||||||
### Maintainers
|
|
||||||
|
|
||||||
Help maintaining fsnotify is welcome. To be a maintainer:
|
|
||||||
|
|
||||||
* Submit a pull request and sign the CLA as above.
|
|
||||||
* You must be able to run the test suite on Mac, Windows, Linux and BSD.
|
|
||||||
|
|
||||||
To keep master clean, the fsnotify project uses the "apply mail" workflow outlined in Nathaniel Talbott's post ["Merge pull request" Considered Harmful][am]. This requires installing [hub][].
|
|
||||||
|
|
||||||
All code changes should be internal pull requests.
|
|
||||||
|
|
||||||
Releases are tagged using [Semantic Versioning](http://semver.org/).
|
|
||||||
|
|
||||||
[hub]: https://github.com/github/hub
|
|
||||||
[am]: http://blog.spreedly.com/2014/06/24/merge-pull-request-considered-harmful/#.VGa5yZPF_Zs
|
|
79
vendor/github.com/fsnotify/fsnotify/README.md
generated
vendored
79
vendor/github.com/fsnotify/fsnotify/README.md
generated
vendored
|
@ -1,79 +0,0 @@
|
||||||
# File system notifications for Go
|
|
||||||
|
|
||||||
[![GoDoc](https://godoc.org/github.com/fsnotify/fsnotify?status.svg)](https://godoc.org/github.com/fsnotify/fsnotify) [![Go Report Card](https://goreportcard.com/badge/github.com/fsnotify/fsnotify)](https://goreportcard.com/report/github.com/fsnotify/fsnotify)
|
|
||||||
|
|
||||||
fsnotify utilizes [golang.org/x/sys](https://godoc.org/golang.org/x/sys) rather than `syscall` from the standard library. Ensure you have the latest version installed by running:
|
|
||||||
|
|
||||||
```console
|
|
||||||
go get -u golang.org/x/sys/...
|
|
||||||
```
|
|
||||||
|
|
||||||
Cross platform: Windows, Linux, BSD and macOS.
|
|
||||||
|
|
||||||
|Adapter |OS |Status |
|
|
||||||
|----------|----------|----------|
|
|
||||||
|inotify |Linux 2.6.27 or later, Android\*|Supported [![Build Status](https://travis-ci.org/fsnotify/fsnotify.svg?branch=master)](https://travis-ci.org/fsnotify/fsnotify)|
|
|
||||||
|kqueue |BSD, macOS, iOS\*|Supported [![Build Status](https://travis-ci.org/fsnotify/fsnotify.svg?branch=master)](https://travis-ci.org/fsnotify/fsnotify)|
|
|
||||||
|ReadDirectoryChangesW|Windows|Supported [![Build status](https://ci.appveyor.com/api/projects/status/ivwjubaih4r0udeh/branch/master?svg=true)](https://ci.appveyor.com/project/NathanYoungman/fsnotify/branch/master)|
|
|
||||||
|FSEvents |macOS |[Planned](https://github.com/fsnotify/fsnotify/issues/11)|
|
|
||||||
|FEN |Solaris 11 |[In Progress](https://github.com/fsnotify/fsnotify/issues/12)|
|
|
||||||
|fanotify |Linux 2.6.37+ | |
|
|
||||||
|USN Journals |Windows |[Maybe](https://github.com/fsnotify/fsnotify/issues/53)|
|
|
||||||
|Polling |*All* |[Maybe](https://github.com/fsnotify/fsnotify/issues/9)|
|
|
||||||
|
|
||||||
\* Android and iOS are untested.
|
|
||||||
|
|
||||||
Please see [the documentation](https://godoc.org/github.com/fsnotify/fsnotify) and consult the [FAQ](#faq) for usage information.
|
|
||||||
|
|
||||||
## API stability
|
|
||||||
|
|
||||||
fsnotify is a fork of [howeyc/fsnotify](https://godoc.org/github.com/howeyc/fsnotify) with a new API as of v1.0. The API is based on [this design document](http://goo.gl/MrYxyA).
|
|
||||||
|
|
||||||
All [releases](https://github.com/fsnotify/fsnotify/releases) are tagged based on [Semantic Versioning](http://semver.org/). Further API changes are [planned](https://github.com/fsnotify/fsnotify/milestones), and will be tagged with a new major revision number.
|
|
||||||
|
|
||||||
Go 1.6 supports dependencies located in the `vendor/` folder. Unless you are creating a library, it is recommended that you copy fsnotify into `vendor/github.com/fsnotify/fsnotify` within your project, and likewise for `golang.org/x/sys`.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Please refer to [CONTRIBUTING][] before opening an issue or pull request.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
See [example_test.go](https://github.com/fsnotify/fsnotify/blob/master/example_test.go).
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
**When a file is moved to another directory is it still being watched?**
|
|
||||||
|
|
||||||
No (it shouldn't be, unless you are watching where it was moved to).
|
|
||||||
|
|
||||||
**When I watch a directory, are all subdirectories watched as well?**
|
|
||||||
|
|
||||||
No, you must add watches for any directory you want to watch (a recursive watcher is on the roadmap [#18][]).
|
|
||||||
|
|
||||||
**Do I have to watch the Error and Event channels in a separate goroutine?**
|
|
||||||
|
|
||||||
As of now, yes. Looking into making this single-thread friendly (see [howeyc #7][#7])
|
|
||||||
|
|
||||||
**Why am I receiving multiple events for the same file on OS X?**
|
|
||||||
|
|
||||||
Spotlight indexing on OS X can result in multiple events (see [howeyc #62][#62]). A temporary workaround is to add your folder(s) to the *Spotlight Privacy settings* until we have a native FSEvents implementation (see [#11][]).
|
|
||||||
|
|
||||||
**How many files can be watched at once?**
|
|
||||||
|
|
||||||
There are OS-specific limits as to how many watches can be created:
|
|
||||||
* Linux: /proc/sys/fs/inotify/max_user_watches contains the limit, reaching this limit results in a "no space left on device" error.
|
|
||||||
* BSD / OSX: sysctl variables "kern.maxfiles" and "kern.maxfilesperproc", reaching these limits results in a "too many open files" error.
|
|
||||||
|
|
||||||
[#62]: https://github.com/howeyc/fsnotify/issues/62
|
|
||||||
[#18]: https://github.com/fsnotify/fsnotify/issues/18
|
|
||||||
[#11]: https://github.com/fsnotify/fsnotify/issues/11
|
|
||||||
[#7]: https://github.com/howeyc/fsnotify/issues/7
|
|
||||||
|
|
||||||
[contributing]: https://github.com/fsnotify/fsnotify/blob/master/CONTRIBUTING.md
|
|
||||||
|
|
||||||
## Related Projects
|
|
||||||
|
|
||||||
* [notify](https://github.com/rjeczalik/notify)
|
|
||||||
* [fsevents](https://github.com/fsnotify/fsevents)
|
|
||||||
|
|
16
vendor/github.com/golang/snappy/.gitignore
generated
vendored
16
vendor/github.com/golang/snappy/.gitignore
generated
vendored
|
@ -1,16 +0,0 @@
|
||||||
cmd/snappytool/snappytool
|
|
||||||
testdata/bench
|
|
||||||
|
|
||||||
# These explicitly listed benchmark data files are for an obsolete version of
|
|
||||||
# snappy_test.go.
|
|
||||||
testdata/alice29.txt
|
|
||||||
testdata/asyoulik.txt
|
|
||||||
testdata/fireworks.jpeg
|
|
||||||
testdata/geo.protodata
|
|
||||||
testdata/html
|
|
||||||
testdata/html_x_4
|
|
||||||
testdata/kppkn.gtb
|
|
||||||
testdata/lcet10.txt
|
|
||||||
testdata/paper-100k.pdf
|
|
||||||
testdata/plrabn12.txt
|
|
||||||
testdata/urls.10K
|
|
107
vendor/github.com/golang/snappy/README
generated
vendored
107
vendor/github.com/golang/snappy/README
generated
vendored
|
@ -1,107 +0,0 @@
|
||||||
The Snappy compression format in the Go programming language.
|
|
||||||
|
|
||||||
To download and install from source:
|
|
||||||
$ go get github.com/golang/snappy
|
|
||||||
|
|
||||||
Unless otherwise noted, the Snappy-Go source files are distributed
|
|
||||||
under the BSD-style license found in the LICENSE file.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Benchmarks.
|
|
||||||
|
|
||||||
The golang/snappy benchmarks include compressing (Z) and decompressing (U) ten
|
|
||||||
or so files, the same set used by the C++ Snappy code (github.com/google/snappy
|
|
||||||
and note the "google", not "golang"). On an "Intel(R) Core(TM) i7-3770 CPU @
|
|
||||||
3.40GHz", Go's GOARCH=amd64 numbers as of 2016-05-29:
|
|
||||||
|
|
||||||
"go test -test.bench=."
|
|
||||||
|
|
||||||
_UFlat0-8 2.19GB/s ± 0% html
|
|
||||||
_UFlat1-8 1.41GB/s ± 0% urls
|
|
||||||
_UFlat2-8 23.5GB/s ± 2% jpg
|
|
||||||
_UFlat3-8 1.91GB/s ± 0% jpg_200
|
|
||||||
_UFlat4-8 14.0GB/s ± 1% pdf
|
|
||||||
_UFlat5-8 1.97GB/s ± 0% html4
|
|
||||||
_UFlat6-8 814MB/s ± 0% txt1
|
|
||||||
_UFlat7-8 785MB/s ± 0% txt2
|
|
||||||
_UFlat8-8 857MB/s ± 0% txt3
|
|
||||||
_UFlat9-8 719MB/s ± 1% txt4
|
|
||||||
_UFlat10-8 2.84GB/s ± 0% pb
|
|
||||||
_UFlat11-8 1.05GB/s ± 0% gaviota
|
|
||||||
|
|
||||||
_ZFlat0-8 1.04GB/s ± 0% html
|
|
||||||
_ZFlat1-8 534MB/s ± 0% urls
|
|
||||||
_ZFlat2-8 15.7GB/s ± 1% jpg
|
|
||||||
_ZFlat3-8 740MB/s ± 3% jpg_200
|
|
||||||
_ZFlat4-8 9.20GB/s ± 1% pdf
|
|
||||||
_ZFlat5-8 991MB/s ± 0% html4
|
|
||||||
_ZFlat6-8 379MB/s ± 0% txt1
|
|
||||||
_ZFlat7-8 352MB/s ± 0% txt2
|
|
||||||
_ZFlat8-8 396MB/s ± 1% txt3
|
|
||||||
_ZFlat9-8 327MB/s ± 1% txt4
|
|
||||||
_ZFlat10-8 1.33GB/s ± 1% pb
|
|
||||||
_ZFlat11-8 605MB/s ± 1% gaviota
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
"go test -test.bench=. -tags=noasm"
|
|
||||||
|
|
||||||
_UFlat0-8 621MB/s ± 2% html
|
|
||||||
_UFlat1-8 494MB/s ± 1% urls
|
|
||||||
_UFlat2-8 23.2GB/s ± 1% jpg
|
|
||||||
_UFlat3-8 1.12GB/s ± 1% jpg_200
|
|
||||||
_UFlat4-8 4.35GB/s ± 1% pdf
|
|
||||||
_UFlat5-8 609MB/s ± 0% html4
|
|
||||||
_UFlat6-8 296MB/s ± 0% txt1
|
|
||||||
_UFlat7-8 288MB/s ± 0% txt2
|
|
||||||
_UFlat8-8 309MB/s ± 1% txt3
|
|
||||||
_UFlat9-8 280MB/s ± 1% txt4
|
|
||||||
_UFlat10-8 753MB/s ± 0% pb
|
|
||||||
_UFlat11-8 400MB/s ± 0% gaviota
|
|
||||||
|
|
||||||
_ZFlat0-8 409MB/s ± 1% html
|
|
||||||
_ZFlat1-8 250MB/s ± 1% urls
|
|
||||||
_ZFlat2-8 12.3GB/s ± 1% jpg
|
|
||||||
_ZFlat3-8 132MB/s ± 0% jpg_200
|
|
||||||
_ZFlat4-8 2.92GB/s ± 0% pdf
|
|
||||||
_ZFlat5-8 405MB/s ± 1% html4
|
|
||||||
_ZFlat6-8 179MB/s ± 1% txt1
|
|
||||||
_ZFlat7-8 170MB/s ± 1% txt2
|
|
||||||
_ZFlat8-8 189MB/s ± 1% txt3
|
|
||||||
_ZFlat9-8 164MB/s ± 1% txt4
|
|
||||||
_ZFlat10-8 479MB/s ± 1% pb
|
|
||||||
_ZFlat11-8 270MB/s ± 1% gaviota
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For comparison (Go's encoded output is byte-for-byte identical to C++'s), here
|
|
||||||
are the numbers from C++ Snappy's
|
|
||||||
|
|
||||||
make CXXFLAGS="-O2 -DNDEBUG -g" clean snappy_unittest.log && cat snappy_unittest.log
|
|
||||||
|
|
||||||
BM_UFlat/0 2.4GB/s html
|
|
||||||
BM_UFlat/1 1.4GB/s urls
|
|
||||||
BM_UFlat/2 21.8GB/s jpg
|
|
||||||
BM_UFlat/3 1.5GB/s jpg_200
|
|
||||||
BM_UFlat/4 13.3GB/s pdf
|
|
||||||
BM_UFlat/5 2.1GB/s html4
|
|
||||||
BM_UFlat/6 1.0GB/s txt1
|
|
||||||
BM_UFlat/7 959.4MB/s txt2
|
|
||||||
BM_UFlat/8 1.0GB/s txt3
|
|
||||||
BM_UFlat/9 864.5MB/s txt4
|
|
||||||
BM_UFlat/10 2.9GB/s pb
|
|
||||||
BM_UFlat/11 1.2GB/s gaviota
|
|
||||||
|
|
||||||
BM_ZFlat/0 944.3MB/s html (22.31 %)
|
|
||||||
BM_ZFlat/1 501.6MB/s urls (47.78 %)
|
|
||||||
BM_ZFlat/2 14.3GB/s jpg (99.95 %)
|
|
||||||
BM_ZFlat/3 538.3MB/s jpg_200 (73.00 %)
|
|
||||||
BM_ZFlat/4 8.3GB/s pdf (83.30 %)
|
|
||||||
BM_ZFlat/5 903.5MB/s html4 (22.52 %)
|
|
||||||
BM_ZFlat/6 336.0MB/s txt1 (57.88 %)
|
|
||||||
BM_ZFlat/7 312.3MB/s txt2 (61.91 %)
|
|
||||||
BM_ZFlat/8 353.1MB/s txt3 (54.99 %)
|
|
||||||
BM_ZFlat/9 289.9MB/s txt4 (66.26 %)
|
|
||||||
BM_ZFlat/10 1.2GB/s pb (19.68 %)
|
|
||||||
BM_ZFlat/11 527.4MB/s gaviota (37.72 %)
|
|
89
vendor/github.com/hashicorp/errwrap/README.md
generated
vendored
89
vendor/github.com/hashicorp/errwrap/README.md
generated
vendored
|
@ -1,89 +0,0 @@
|
||||||
# errwrap
|
|
||||||
|
|
||||||
`errwrap` is a package for Go that formalizes the pattern of wrapping errors
|
|
||||||
and checking if an error contains another error.
|
|
||||||
|
|
||||||
There is a common pattern in Go of taking a returned `error` value and
|
|
||||||
then wrapping it (such as with `fmt.Errorf`) before returning it. The problem
|
|
||||||
with this pattern is that you completely lose the original `error` structure.
|
|
||||||
|
|
||||||
Arguably the _correct_ approach is that you should make a custom structure
|
|
||||||
implementing the `error` interface, and have the original error as a field
|
|
||||||
on that structure, such [as this example](http://golang.org/pkg/os/#PathError).
|
|
||||||
This is a good approach, but you have to know the entire chain of possible
|
|
||||||
rewrapping that happens, when you might just care about one.
|
|
||||||
|
|
||||||
`errwrap` formalizes this pattern (it doesn't matter what approach you use
|
|
||||||
above) by giving a single interface for wrapping errors, checking if a specific
|
|
||||||
error is wrapped, and extracting that error.
|
|
||||||
|
|
||||||
## Installation and Docs
|
|
||||||
|
|
||||||
Install using `go get github.com/hashicorp/errwrap`.
|
|
||||||
|
|
||||||
Full documentation is available at
|
|
||||||
http://godoc.org/github.com/hashicorp/errwrap
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
#### Basic Usage
|
|
||||||
|
|
||||||
Below is a very basic example of its usage:
|
|
||||||
|
|
||||||
```go
|
|
||||||
// A function that always returns an error, but wraps it, like a real
|
|
||||||
// function might.
|
|
||||||
func tryOpen() error {
|
|
||||||
_, err := os.Open("/i/dont/exist")
|
|
||||||
if err != nil {
|
|
||||||
return errwrap.Wrapf("Doesn't exist: {{err}}", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
err := tryOpen()
|
|
||||||
|
|
||||||
// We can use the Contains helpers to check if an error contains
|
|
||||||
// another error. It is safe to do this with a nil error, or with
|
|
||||||
// an error that doesn't even use the errwrap package.
|
|
||||||
if errwrap.Contains(err, ErrNotExist) {
|
|
||||||
// Do something
|
|
||||||
}
|
|
||||||
if errwrap.ContainsType(err, new(os.PathError)) {
|
|
||||||
// Do something
|
|
||||||
}
|
|
||||||
|
|
||||||
// Or we can use the associated `Get` functions to just extract
|
|
||||||
// a specific error. This would return nil if that specific error doesn't
|
|
||||||
// exist.
|
|
||||||
perr := errwrap.GetType(err, new(os.PathError))
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Custom Types
|
|
||||||
|
|
||||||
If you're already making custom types that properly wrap errors, then
|
|
||||||
you can get all the functionality of `errwraps.Contains` and such by
|
|
||||||
implementing the `Wrapper` interface with just one function. Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type AppError {
|
|
||||||
Code ErrorCode
|
|
||||||
Err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *AppError) WrappedErrors() []error {
|
|
||||||
return []error{e.Err}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Now this works:
|
|
||||||
|
|
||||||
```go
|
|
||||||
err := &AppError{Err: fmt.Errorf("an error")}
|
|
||||||
if errwrap.ContainsType(err, fmt.Errorf("")) {
|
|
||||||
// This will work!
|
|
||||||
}
|
|
||||||
```
|
|
30
vendor/github.com/hashicorp/go-cleanhttp/README.md
generated
vendored
30
vendor/github.com/hashicorp/go-cleanhttp/README.md
generated
vendored
|
@ -1,30 +0,0 @@
|
||||||
# cleanhttp
|
|
||||||
|
|
||||||
Functions for accessing "clean" Go http.Client values
|
|
||||||
|
|
||||||
-------------
|
|
||||||
|
|
||||||
The Go standard library contains a default `http.Client` called
|
|
||||||
`http.DefaultClient`. It is a common idiom in Go code to start with
|
|
||||||
`http.DefaultClient` and tweak it as necessary, and in fact, this is
|
|
||||||
encouraged; from the `http` package documentation:
|
|
||||||
|
|
||||||
> The Client's Transport typically has internal state (cached TCP connections),
|
|
||||||
so Clients should be reused instead of created as needed. Clients are safe for
|
|
||||||
concurrent use by multiple goroutines.
|
|
||||||
|
|
||||||
Unfortunately, this is a shared value, and it is not uncommon for libraries to
|
|
||||||
assume that they are free to modify it at will. With enough dependencies, it
|
|
||||||
can be very easy to encounter strange problems and race conditions due to
|
|
||||||
manipulation of this shared value across libraries and goroutines (clients are
|
|
||||||
safe for concurrent use, but writing values to the client struct itself is not
|
|
||||||
protected).
|
|
||||||
|
|
||||||
Making things worse is the fact that a bare `http.Client` will use a default
|
|
||||||
`http.Transport` called `http.DefaultTransport`, which is another global value
|
|
||||||
that behaves the same way. So it is not simply enough to replace
|
|
||||||
`http.DefaultClient` with `&http.Client{}`.
|
|
||||||
|
|
||||||
This repository provides some simple functions to get a "clean" `http.Client`
|
|
||||||
-- one that uses the same default values as the Go standard library, but
|
|
||||||
returns a client that does not share any state with other clients.
|
|
12
vendor/github.com/hashicorp/go-multierror/.travis.yml
generated
vendored
12
vendor/github.com/hashicorp/go-multierror/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.x
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
script: make test testrace
|
|
31
vendor/github.com/hashicorp/go-multierror/Makefile
generated
vendored
31
vendor/github.com/hashicorp/go-multierror/Makefile
generated
vendored
|
@ -1,31 +0,0 @@
|
||||||
TEST?=./...
|
|
||||||
|
|
||||||
default: test
|
|
||||||
|
|
||||||
# test runs the test suite and vets the code.
|
|
||||||
test: generate
|
|
||||||
@echo "==> Running tests..."
|
|
||||||
@go list $(TEST) \
|
|
||||||
| grep -v "/vendor/" \
|
|
||||||
| xargs -n1 go test -timeout=60s -parallel=10 ${TESTARGS}
|
|
||||||
|
|
||||||
# testrace runs the race checker
|
|
||||||
testrace: generate
|
|
||||||
@echo "==> Running tests (race)..."
|
|
||||||
@go list $(TEST) \
|
|
||||||
| grep -v "/vendor/" \
|
|
||||||
| xargs -n1 go test -timeout=60s -race ${TESTARGS}
|
|
||||||
|
|
||||||
# updatedeps installs all the dependencies needed to run and build.
|
|
||||||
updatedeps:
|
|
||||||
@sh -c "'${CURDIR}/scripts/deps.sh' '${NAME}'"
|
|
||||||
|
|
||||||
# generate runs `go generate` to build the dynamically generated source files.
|
|
||||||
generate:
|
|
||||||
@echo "==> Generating..."
|
|
||||||
@find . -type f -name '.DS_Store' -delete
|
|
||||||
@go list ./... \
|
|
||||||
| grep -v "/vendor/" \
|
|
||||||
| xargs -n1 go generate
|
|
||||||
|
|
||||||
.PHONY: default test testrace updatedeps generate
|
|
97
vendor/github.com/hashicorp/go-multierror/README.md
generated
vendored
97
vendor/github.com/hashicorp/go-multierror/README.md
generated
vendored
|
@ -1,97 +0,0 @@
|
||||||
# go-multierror
|
|
||||||
|
|
||||||
[![Build Status](http://img.shields.io/travis/hashicorp/go-multierror.svg?style=flat-square)][travis]
|
|
||||||
[![Go Documentation](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)][godocs]
|
|
||||||
|
|
||||||
[travis]: https://travis-ci.org/hashicorp/go-multierror
|
|
||||||
[godocs]: https://godoc.org/github.com/hashicorp/go-multierror
|
|
||||||
|
|
||||||
`go-multierror` is a package for Go that provides a mechanism for
|
|
||||||
representing a list of `error` values as a single `error`.
|
|
||||||
|
|
||||||
This allows a function in Go to return an `error` that might actually
|
|
||||||
be a list of errors. If the caller knows this, they can unwrap the
|
|
||||||
list and access the errors. If the caller doesn't know, the error
|
|
||||||
formats to a nice human-readable format.
|
|
||||||
|
|
||||||
`go-multierror` implements the
|
|
||||||
[errwrap](https://github.com/hashicorp/errwrap) interface so that it can
|
|
||||||
be used with that library, as well.
|
|
||||||
|
|
||||||
## Installation and Docs
|
|
||||||
|
|
||||||
Install using `go get github.com/hashicorp/go-multierror`.
|
|
||||||
|
|
||||||
Full documentation is available at
|
|
||||||
http://godoc.org/github.com/hashicorp/go-multierror
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
go-multierror is easy to use and purposely built to be unobtrusive in
|
|
||||||
existing Go applications/libraries that may not be aware of it.
|
|
||||||
|
|
||||||
**Building a list of errors**
|
|
||||||
|
|
||||||
The `Append` function is used to create a list of errors. This function
|
|
||||||
behaves a lot like the Go built-in `append` function: it doesn't matter
|
|
||||||
if the first argument is nil, a `multierror.Error`, or any other `error`,
|
|
||||||
the function behaves as you would expect.
|
|
||||||
|
|
||||||
```go
|
|
||||||
var result error
|
|
||||||
|
|
||||||
if err := step1(); err != nil {
|
|
||||||
result = multierror.Append(result, err)
|
|
||||||
}
|
|
||||||
if err := step2(); err != nil {
|
|
||||||
result = multierror.Append(result, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return result
|
|
||||||
```
|
|
||||||
|
|
||||||
**Customizing the formatting of the errors**
|
|
||||||
|
|
||||||
By specifying a custom `ErrorFormat`, you can customize the format
|
|
||||||
of the `Error() string` function:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var result *multierror.Error
|
|
||||||
|
|
||||||
// ... accumulate errors here, maybe using Append
|
|
||||||
|
|
||||||
if result != nil {
|
|
||||||
result.ErrorFormat = func([]error) string {
|
|
||||||
return "errors!"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Accessing the list of errors**
|
|
||||||
|
|
||||||
`multierror.Error` implements `error` so if the caller doesn't know about
|
|
||||||
multierror, it will work just fine. But if you're aware a multierror might
|
|
||||||
be returned, you can use type switches to access the list of errors:
|
|
||||||
|
|
||||||
```go
|
|
||||||
if err := something(); err != nil {
|
|
||||||
if merr, ok := err.(*multierror.Error); ok {
|
|
||||||
// Use merr.Errors
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returning a multierror only if there are errors**
|
|
||||||
|
|
||||||
If you build a `multierror.Error`, you can use the `ErrorOrNil` function
|
|
||||||
to return an `error` implementation only if there are errors to return:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var result *multierror.Error
|
|
||||||
|
|
||||||
// ... accumulate errors here
|
|
||||||
|
|
||||||
// Return the `error` only if errors were added to the multierror, otherwise
|
|
||||||
// return nil since there are no errors.
|
|
||||||
return result.ErrorOrNil()
|
|
||||||
```
|
|
12
vendor/github.com/hashicorp/go-rootcerts/.travis.yml
generated
vendored
12
vendor/github.com/hashicorp/go-rootcerts/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.6
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
script: make test
|
|
8
vendor/github.com/hashicorp/go-rootcerts/Makefile
generated
vendored
8
vendor/github.com/hashicorp/go-rootcerts/Makefile
generated
vendored
|
@ -1,8 +0,0 @@
|
||||||
TEST?=./...
|
|
||||||
|
|
||||||
test:
|
|
||||||
go test $(TEST) $(TESTARGS) -timeout=3s -parallel=4
|
|
||||||
go vet $(TEST)
|
|
||||||
go test $(TEST) -race
|
|
||||||
|
|
||||||
.PHONY: test
|
|
43
vendor/github.com/hashicorp/go-rootcerts/README.md
generated
vendored
43
vendor/github.com/hashicorp/go-rootcerts/README.md
generated
vendored
|
@ -1,43 +0,0 @@
|
||||||
# rootcerts
|
|
||||||
|
|
||||||
Functions for loading root certificates for TLS connections.
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
Go's standard library `crypto/tls` provides a common mechanism for configuring
|
|
||||||
TLS connections in `tls.Config`. The `RootCAs` field on this struct is a pool
|
|
||||||
of certificates for the client to use as a trust store when verifying server
|
|
||||||
certificates.
|
|
||||||
|
|
||||||
This library contains utility functions for loading certificates destined for
|
|
||||||
that field, as well as one other important thing:
|
|
||||||
|
|
||||||
When the `RootCAs` field is `nil`, the standard library attempts to load the
|
|
||||||
host's root CA set. This behavior is OS-specific, and the Darwin
|
|
||||||
implementation contains [a bug that prevents trusted certificates from the
|
|
||||||
System and Login keychains from being loaded][1]. This library contains
|
|
||||||
Darwin-specific behavior that works around that bug.
|
|
||||||
|
|
||||||
[1]: https://github.com/golang/go/issues/14514
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
Here's a snippet demonstrating how this library is meant to be used:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func httpClient() (*http.Client, error)
|
|
||||||
tlsConfig := &tls.Config{}
|
|
||||||
err := rootcerts.ConfigureTLS(tlsConfig, &rootcerts.Config{
|
|
||||||
CAFile: os.Getenv("MYAPP_CAFILE"),
|
|
||||||
CAPath: os.Getenv("MYAPP_CAPATH"),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
c := cleanhttp.DefaultClient()
|
|
||||||
t := cleanhttp.DefaultTransport()
|
|
||||||
t.TLSClientConfig = tlsConfig
|
|
||||||
c.Transport = t
|
|
||||||
return c, nil
|
|
||||||
}
|
|
||||||
```
|
|
26
vendor/github.com/hashicorp/go-sockaddr/.gitignore
generated
vendored
26
vendor/github.com/hashicorp/go-sockaddr/.gitignore
generated
vendored
|
@ -1,26 +0,0 @@
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
*.exe
|
|
||||||
*.test
|
|
||||||
*.prof
|
|
||||||
.cover.out*
|
|
||||||
coverage.html
|
|
65
vendor/github.com/hashicorp/go-sockaddr/GNUmakefile
generated
vendored
65
vendor/github.com/hashicorp/go-sockaddr/GNUmakefile
generated
vendored
|
@ -1,65 +0,0 @@
|
||||||
TOOLS= golang.org/x/tools/cover
|
|
||||||
GOCOVER_TMPFILE?= $(GOCOVER_FILE).tmp
|
|
||||||
GOCOVER_FILE?= .cover.out
|
|
||||||
GOCOVERHTML?= coverage.html
|
|
||||||
FIND=`/usr/bin/which 2> /dev/null gfind find | /usr/bin/grep -v ^no | /usr/bin/head -n 1`
|
|
||||||
XARGS=`/usr/bin/which 2> /dev/null gxargs xargs | /usr/bin/grep -v ^no | /usr/bin/head -n 1`
|
|
||||||
|
|
||||||
test:: $(GOCOVER_FILE)
|
|
||||||
@$(MAKE) -C cmd/sockaddr test
|
|
||||||
|
|
||||||
cover:: coverage_report
|
|
||||||
|
|
||||||
$(GOCOVER_FILE)::
|
|
||||||
@${FIND} . -type d ! -path '*cmd*' ! -path '*.git*' -print0 | ${XARGS} -0 -I % sh -ec "cd % && rm -f $(GOCOVER_TMPFILE) && go test -coverprofile=$(GOCOVER_TMPFILE)"
|
|
||||||
|
|
||||||
@echo 'mode: set' > $(GOCOVER_FILE)
|
|
||||||
@${FIND} . -type f ! -path '*cmd*' ! -path '*.git*' -name "$(GOCOVER_TMPFILE)" -print0 | ${XARGS} -0 -n1 cat $(GOCOVER_TMPFILE) | grep -v '^mode: ' >> ${PWD}/$(GOCOVER_FILE)
|
|
||||||
|
|
||||||
$(GOCOVERHTML): $(GOCOVER_FILE)
|
|
||||||
go tool cover -html=$(GOCOVER_FILE) -o $(GOCOVERHTML)
|
|
||||||
|
|
||||||
coverage_report:: $(GOCOVER_FILE)
|
|
||||||
go tool cover -html=$(GOCOVER_FILE)
|
|
||||||
|
|
||||||
audit_tools::
|
|
||||||
@go get -u github.com/golang/lint/golint && echo "Installed golint:"
|
|
||||||
@go get -u github.com/fzipp/gocyclo && echo "Installed gocyclo:"
|
|
||||||
@go get -u github.com/remyoudompheng/go-misc/deadcode && echo "Installed deadcode:"
|
|
||||||
@go get -u github.com/client9/misspell/cmd/misspell && echo "Installed misspell:"
|
|
||||||
@go get -u github.com/gordonklaus/ineffassign && echo "Installed ineffassign:"
|
|
||||||
|
|
||||||
audit::
|
|
||||||
deadcode
|
|
||||||
go tool vet -all *.go
|
|
||||||
go tool vet -shadow=true *.go
|
|
||||||
golint *.go
|
|
||||||
ineffassign .
|
|
||||||
gocyclo -over 65 *.go
|
|
||||||
misspell *.go
|
|
||||||
|
|
||||||
clean::
|
|
||||||
rm -f $(GOCOVER_FILE) $(GOCOVERHTML)
|
|
||||||
|
|
||||||
dev::
|
|
||||||
@go build
|
|
||||||
@$(MAKE) -B -C cmd/sockaddr sockaddr
|
|
||||||
|
|
||||||
install::
|
|
||||||
@go install
|
|
||||||
@$(MAKE) -C cmd/sockaddr install
|
|
||||||
|
|
||||||
doc::
|
|
||||||
@echo Visit: http://127.0.0.1:6161/pkg/github.com/hashicorp/go-sockaddr/
|
|
||||||
godoc -http=:6161 -goroot $GOROOT
|
|
||||||
|
|
||||||
world::
|
|
||||||
@set -e; \
|
|
||||||
for os in solaris darwin freebsd linux windows; do \
|
|
||||||
for arch in amd64; do \
|
|
||||||
printf "Building on %s-%s\n" "$${os}" "$${arch}" ; \
|
|
||||||
env GOOS="$${os}" GOARCH="$${arch}" go build -o /dev/null; \
|
|
||||||
done; \
|
|
||||||
done
|
|
||||||
|
|
||||||
$(MAKE) -C cmd/sockaddr world
|
|
118
vendor/github.com/hashicorp/go-sockaddr/README.md
generated
vendored
118
vendor/github.com/hashicorp/go-sockaddr/README.md
generated
vendored
|
@ -1,118 +0,0 @@
|
||||||
# go-sockaddr
|
|
||||||
|
|
||||||
## `sockaddr` Library
|
|
||||||
|
|
||||||
Socket address convenience functions for Go. `go-sockaddr` is a convenience
|
|
||||||
library that makes doing the right thing with IP addresses easy. `go-sockaddr`
|
|
||||||
is loosely modeled after the UNIX `sockaddr_t` and creates a union of the family
|
|
||||||
of `sockaddr_t` types (see below for an ascii diagram). Library documentation
|
|
||||||
is available
|
|
||||||
at
|
|
||||||
[https://godoc.org/github.com/hashicorp/go-sockaddr](https://godoc.org/github.com/hashicorp/go-sockaddr).
|
|
||||||
The primary intent of the library was to make it possible to define heuristics
|
|
||||||
for selecting the correct IP addresses when a configuration is evaluated at
|
|
||||||
runtime. See
|
|
||||||
the
|
|
||||||
[docs](https://godoc.org/github.com/hashicorp/go-sockaddr),
|
|
||||||
[`template` package](https://godoc.org/github.com/hashicorp/go-sockaddr/template),
|
|
||||||
tests,
|
|
||||||
and
|
|
||||||
[CLI utility](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr)
|
|
||||||
for details and hints as to how to use this library.
|
|
||||||
|
|
||||||
For example, with this library it is possible to find an IP address that:
|
|
||||||
|
|
||||||
* is attached to a default route
|
|
||||||
([`GetDefaultInterfaces()`](https://godoc.org/github.com/hashicorp/go-sockaddr#GetDefaultInterfaces))
|
|
||||||
* is contained within a CIDR block ([`IfByNetwork()`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByNetwork))
|
|
||||||
* is an RFC1918 address
|
|
||||||
([`IfByRFC("1918")`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByRFC))
|
|
||||||
* is ordered
|
|
||||||
([`OrderedIfAddrBy(args)`](https://godoc.org/github.com/hashicorp/go-sockaddr#OrderedIfAddrBy) where
|
|
||||||
`args` includes, but is not limited
|
|
||||||
to,
|
|
||||||
[`AscIfType`](https://godoc.org/github.com/hashicorp/go-sockaddr#AscIfType),
|
|
||||||
[`AscNetworkSize`](https://godoc.org/github.com/hashicorp/go-sockaddr#AscNetworkSize))
|
|
||||||
* excludes all IPv6 addresses
|
|
||||||
([`IfByType("^(IPv4)$")`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByType))
|
|
||||||
* is larger than a `/32`
|
|
||||||
([`IfByMaskSize(32)`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByMaskSize))
|
|
||||||
* is not on a `down` interface
|
|
||||||
([`ExcludeIfs("flags", "down")`](https://godoc.org/github.com/hashicorp/go-sockaddr#ExcludeIfs))
|
|
||||||
* preferences an IPv6 address over an IPv4 address
|
|
||||||
([`SortIfByType()`](https://godoc.org/github.com/hashicorp/go-sockaddr#SortIfByType) +
|
|
||||||
[`ReverseIfAddrs()`](https://godoc.org/github.com/hashicorp/go-sockaddr#ReverseIfAddrs)); and
|
|
||||||
* excludes any IP in RFC6890 address
|
|
||||||
([`IfByRFC("6890")`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByRFC))
|
|
||||||
|
|
||||||
Or any combination or variation therein.
|
|
||||||
|
|
||||||
There are also a few simple helper functions such as `GetPublicIP` and
|
|
||||||
`GetPrivateIP` which both return strings and select the first public or private
|
|
||||||
IP address on the default interface, respectively. Similarly, there is also a
|
|
||||||
helper function called `GetInterfaceIP` which returns the first usable IP
|
|
||||||
address on the named interface.
|
|
||||||
|
|
||||||
## `sockaddr` CLI
|
|
||||||
|
|
||||||
Given the possible complexity of the `sockaddr` library, there is a CLI utility
|
|
||||||
that accompanies the library, also
|
|
||||||
called
|
|
||||||
[`sockaddr`](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr).
|
|
||||||
The
|
|
||||||
[`sockaddr`](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr)
|
|
||||||
utility exposes nearly all of the functionality of the library and can be used
|
|
||||||
either as an administrative tool or testing tool. To install
|
|
||||||
the
|
|
||||||
[`sockaddr`](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr),
|
|
||||||
run:
|
|
||||||
|
|
||||||
```text
|
|
||||||
$ go get -u github.com/hashicorp/go-sockaddr/cmd/sockaddr
|
|
||||||
```
|
|
||||||
|
|
||||||
If you're familiar with UNIX's `sockaddr` struct's, the following diagram
|
|
||||||
mapping the C `sockaddr` (top) to `go-sockaddr` structs (bottom) and
|
|
||||||
interfaces will be helpful:
|
|
||||||
|
|
||||||
```
|
|
||||||
+-------------------------------------------------------+
|
|
||||||
| |
|
|
||||||
| sockaddr |
|
|
||||||
| SockAddr |
|
|
||||||
| |
|
|
||||||
| +--------------+ +----------------------------------+ |
|
|
||||||
| | sockaddr_un | | | |
|
|
||||||
| | SockAddrUnix | | sockaddr_in{,6} | |
|
|
||||||
| +--------------+ | IPAddr | |
|
|
||||||
| | | |
|
|
||||||
| | +-------------+ +--------------+ | |
|
|
||||||
| | | sockaddr_in | | sockaddr_in6 | | |
|
|
||||||
| | | IPv4Addr | | IPv6Addr | | |
|
|
||||||
| | +-------------+ +--------------+ | |
|
|
||||||
| | | |
|
|
||||||
| +----------------------------------+ |
|
|
||||||
| |
|
|
||||||
+-------------------------------------------------------+
|
|
||||||
```
|
|
||||||
|
|
||||||
## Inspiration and Design
|
|
||||||
|
|
||||||
There were many subtle inspirations that led to this design, but the most direct
|
|
||||||
inspiration for the filtering syntax was
|
|
||||||
OpenBSD's
|
|
||||||
[`pf.conf(5)`](https://www.freebsd.org/cgi/man.cgi?query=pf.conf&apropos=0&sektion=0&arch=default&format=html#PARAMETERS) firewall
|
|
||||||
syntax that lets you select the first IP address on a given named interface.
|
|
||||||
The original problem stemmed from:
|
|
||||||
|
|
||||||
* needing to create immutable images using [Packer](https://www.packer.io) that
|
|
||||||
ran the [Consul](https://www.consul.io) process (Consul can only use one IP
|
|
||||||
address at a time);
|
|
||||||
* images that may or may not have multiple interfaces or IP addresses at
|
|
||||||
runtime; and
|
|
||||||
* we didn't want to rely on configuration management to render out the correct
|
|
||||||
IP address if the VM image was being used in an auto-scaling group.
|
|
||||||
|
|
||||||
Instead we needed some way to codify a heuristic that would correctly select the
|
|
||||||
right IP address but the input parameters were not known when the image was
|
|
||||||
created.
|
|
9
vendor/github.com/hashicorp/hcl/.gitignore
generated
vendored
9
vendor/github.com/hashicorp/hcl/.gitignore
generated
vendored
|
@ -1,9 +0,0 @@
|
||||||
y.output
|
|
||||||
|
|
||||||
# ignore intellij files
|
|
||||||
.idea
|
|
||||||
*.iml
|
|
||||||
*.ipr
|
|
||||||
*.iws
|
|
||||||
|
|
||||||
*.test
|
|
13
vendor/github.com/hashicorp/hcl/.travis.yml
generated
vendored
13
vendor/github.com/hashicorp/hcl/.travis.yml
generated
vendored
|
@ -1,13 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.x
|
|
||||||
- tip
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
script: make test
|
|
18
vendor/github.com/hashicorp/hcl/Makefile
generated
vendored
18
vendor/github.com/hashicorp/hcl/Makefile
generated
vendored
|
@ -1,18 +0,0 @@
|
||||||
TEST?=./...
|
|
||||||
|
|
||||||
default: test
|
|
||||||
|
|
||||||
fmt: generate
|
|
||||||
go fmt ./...
|
|
||||||
|
|
||||||
test: generate
|
|
||||||
go get -t ./...
|
|
||||||
go test $(TEST) $(TESTARGS)
|
|
||||||
|
|
||||||
generate:
|
|
||||||
go generate ./...
|
|
||||||
|
|
||||||
updatedeps:
|
|
||||||
go get -u golang.org/x/tools/cmd/stringer
|
|
||||||
|
|
||||||
.PHONY: default generate test updatedeps
|
|
125
vendor/github.com/hashicorp/hcl/README.md
generated
vendored
125
vendor/github.com/hashicorp/hcl/README.md
generated
vendored
|
@ -1,125 +0,0 @@
|
||||||
# HCL
|
|
||||||
|
|
||||||
[![GoDoc](https://godoc.org/github.com/hashicorp/hcl?status.png)](https://godoc.org/github.com/hashicorp/hcl) [![Build Status](https://travis-ci.org/hashicorp/hcl.svg?branch=master)](https://travis-ci.org/hashicorp/hcl)
|
|
||||||
|
|
||||||
HCL (HashiCorp Configuration Language) is a configuration language built
|
|
||||||
by HashiCorp. The goal of HCL is to build a structured configuration language
|
|
||||||
that is both human and machine friendly for use with command-line tools, but
|
|
||||||
specifically targeted towards DevOps tools, servers, etc.
|
|
||||||
|
|
||||||
HCL is also fully JSON compatible. That is, JSON can be used as completely
|
|
||||||
valid input to a system expecting HCL. This helps makes systems
|
|
||||||
interoperable with other systems.
|
|
||||||
|
|
||||||
HCL is heavily inspired by
|
|
||||||
[libucl](https://github.com/vstakhov/libucl),
|
|
||||||
nginx configuration, and others similar.
|
|
||||||
|
|
||||||
## Why?
|
|
||||||
|
|
||||||
A common question when viewing HCL is to ask the question: why not
|
|
||||||
JSON, YAML, etc.?
|
|
||||||
|
|
||||||
Prior to HCL, the tools we built at [HashiCorp](http://www.hashicorp.com)
|
|
||||||
used a variety of configuration languages from full programming languages
|
|
||||||
such as Ruby to complete data structure languages such as JSON. What we
|
|
||||||
learned is that some people wanted human-friendly configuration languages
|
|
||||||
and some people wanted machine-friendly languages.
|
|
||||||
|
|
||||||
JSON fits a nice balance in this, but is fairly verbose and most
|
|
||||||
importantly doesn't support comments. With YAML, we found that beginners
|
|
||||||
had a really hard time determining what the actual structure was, and
|
|
||||||
ended up guessing more often than not whether to use a hyphen, colon, etc.
|
|
||||||
in order to represent some configuration key.
|
|
||||||
|
|
||||||
Full programming languages such as Ruby enable complex behavior
|
|
||||||
a configuration language shouldn't usually allow, and also forces
|
|
||||||
people to learn some set of Ruby.
|
|
||||||
|
|
||||||
Because of this, we decided to create our own configuration language
|
|
||||||
that is JSON-compatible. Our configuration language (HCL) is designed
|
|
||||||
to be written and modified by humans. The API for HCL allows JSON
|
|
||||||
as an input so that it is also machine-friendly (machines can generate
|
|
||||||
JSON instead of trying to generate HCL).
|
|
||||||
|
|
||||||
Our goal with HCL is not to alienate other configuration languages.
|
|
||||||
It is instead to provide HCL as a specialized language for our tools,
|
|
||||||
and JSON as the interoperability layer.
|
|
||||||
|
|
||||||
## Syntax
|
|
||||||
|
|
||||||
For a complete grammar, please see the parser itself. A high-level overview
|
|
||||||
of the syntax and grammar is listed here.
|
|
||||||
|
|
||||||
* Single line comments start with `#` or `//`
|
|
||||||
|
|
||||||
* Multi-line comments are wrapped in `/*` and `*/`. Nested block comments
|
|
||||||
are not allowed. A multi-line comment (also known as a block comment)
|
|
||||||
terminates at the first `*/` found.
|
|
||||||
|
|
||||||
* Values are assigned with the syntax `key = value` (whitespace doesn't
|
|
||||||
matter). The value can be any primitive: a string, number, boolean,
|
|
||||||
object, or list.
|
|
||||||
|
|
||||||
* Strings are double-quoted and can contain any UTF-8 characters.
|
|
||||||
Example: `"Hello, World"`
|
|
||||||
|
|
||||||
* Multi-line strings start with `<<EOF` at the end of a line, and end
|
|
||||||
with `EOF` on its own line ([here documents](https://en.wikipedia.org/wiki/Here_document)).
|
|
||||||
Any text may be used in place of `EOF`. Example:
|
|
||||||
```
|
|
||||||
<<FOO
|
|
||||||
hello
|
|
||||||
world
|
|
||||||
FOO
|
|
||||||
```
|
|
||||||
|
|
||||||
* Numbers are assumed to be base 10. If you prefix a number with 0x,
|
|
||||||
it is treated as a hexadecimal. If it is prefixed with 0, it is
|
|
||||||
treated as an octal. Numbers can be in scientific notation: "1e10".
|
|
||||||
|
|
||||||
* Boolean values: `true`, `false`
|
|
||||||
|
|
||||||
* Arrays can be made by wrapping it in `[]`. Example:
|
|
||||||
`["foo", "bar", 42]`. Arrays can contain primitives,
|
|
||||||
other arrays, and objects. As an alternative, lists
|
|
||||||
of objects can be created with repeated blocks, using
|
|
||||||
this structure:
|
|
||||||
|
|
||||||
```hcl
|
|
||||||
service {
|
|
||||||
key = "value"
|
|
||||||
}
|
|
||||||
|
|
||||||
service {
|
|
||||||
key = "value"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Objects and nested objects are created using the structure shown below:
|
|
||||||
|
|
||||||
```
|
|
||||||
variable "ami" {
|
|
||||||
description = "the AMI to use"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
This would be equivalent to the following json:
|
|
||||||
``` json
|
|
||||||
{
|
|
||||||
"variable": {
|
|
||||||
"ami": {
|
|
||||||
"description": "the AMI to use"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Thanks
|
|
||||||
|
|
||||||
Thanks to:
|
|
||||||
|
|
||||||
* [@vstakhov](https://github.com/vstakhov) - The original libucl parser
|
|
||||||
and syntax that HCL was based off of.
|
|
||||||
|
|
||||||
* [@fatih](https://github.com/fatih) - The rewritten HCL parser
|
|
||||||
in pure Go (no goyacc) and support for a printer.
|
|
19
vendor/github.com/hashicorp/hcl/appveyor.yml
generated
vendored
19
vendor/github.com/hashicorp/hcl/appveyor.yml
generated
vendored
|
@ -1,19 +0,0 @@
|
||||||
version: "build-{branch}-{build}"
|
|
||||||
image: Visual Studio 2015
|
|
||||||
clone_folder: c:\gopath\src\github.com\hashicorp\hcl
|
|
||||||
environment:
|
|
||||||
GOPATH: c:\gopath
|
|
||||||
init:
|
|
||||||
- git config --global core.autocrlf false
|
|
||||||
install:
|
|
||||||
- cmd: >-
|
|
||||||
echo %Path%
|
|
||||||
|
|
||||||
go version
|
|
||||||
|
|
||||||
go env
|
|
||||||
|
|
||||||
go get -t ./...
|
|
||||||
|
|
||||||
build_script:
|
|
||||||
- cmd: go test -v ./...
|
|
23
vendor/github.com/inconshreveable/mousetrap/README.md
generated
vendored
23
vendor/github.com/inconshreveable/mousetrap/README.md
generated
vendored
|
@ -1,23 +0,0 @@
|
||||||
# mousetrap
|
|
||||||
|
|
||||||
mousetrap is a tiny library that answers a single question.
|
|
||||||
|
|
||||||
On a Windows machine, was the process invoked by someone double clicking on
|
|
||||||
the executable file while browsing in explorer?
|
|
||||||
|
|
||||||
### Motivation
|
|
||||||
|
|
||||||
Windows developers unfamiliar with command line tools will often "double-click"
|
|
||||||
the executable for a tool. Because most CLI tools print the help and then exit
|
|
||||||
when invoked without arguments, this is often very frustrating for those users.
|
|
||||||
|
|
||||||
mousetrap provides a way to detect these invocations so that you can provide
|
|
||||||
more helpful behavior and instructions on how to run the CLI tool. To see what
|
|
||||||
this looks like, both from an organizational and a technical perspective, see
|
|
||||||
https://inconshreveable.com/09-09-2014/sweat-the-small-stuff/
|
|
||||||
|
|
||||||
### The interface
|
|
||||||
|
|
||||||
The library exposes a single interface:
|
|
||||||
|
|
||||||
func StartedByExplorer() (bool)
|
|
6
vendor/github.com/magiconair/properties/.gitignore
generated
vendored
6
vendor/github.com/magiconair/properties/.gitignore
generated
vendored
|
@ -1,6 +0,0 @@
|
||||||
*.sublime-project
|
|
||||||
*.sublime-workspace
|
|
||||||
*.un~
|
|
||||||
*.swp
|
|
||||||
.idea/
|
|
||||||
*.iml
|
|
10
vendor/github.com/magiconair/properties/.travis.yml
generated
vendored
10
vendor/github.com/magiconair/properties/.travis.yml
generated
vendored
|
@ -1,10 +0,0 @@
|
||||||
language: go
|
|
||||||
go:
|
|
||||||
- 1.4.x
|
|
||||||
- 1.5.x
|
|
||||||
- 1.6.x
|
|
||||||
- 1.7.x
|
|
||||||
- 1.8.x
|
|
||||||
- 1.9.x
|
|
||||||
- "1.10.x"
|
|
||||||
- tip
|
|
131
vendor/github.com/magiconair/properties/CHANGELOG.md
generated
vendored
131
vendor/github.com/magiconair/properties/CHANGELOG.md
generated
vendored
|
@ -1,131 +0,0 @@
|
||||||
## Changelog
|
|
||||||
|
|
||||||
### [1.8](https://github.com/magiconair/properties/tree/v1.8) - 15 May 2018
|
|
||||||
|
|
||||||
* [PR #26](https://github.com/magiconair/properties/pull/26): Disable expansion during loading
|
|
||||||
|
|
||||||
This adds the option to disable property expansion during loading.
|
|
||||||
|
|
||||||
Thanks to [@kmala](https://github.com/kmala) for the patch.
|
|
||||||
|
|
||||||
### [1.7.6](https://github.com/magiconair/properties/tree/v1.7.6) - 14 Feb 2018
|
|
||||||
|
|
||||||
* [PR #29](https://github.com/magiconair/properties/pull/29): Reworked expansion logic to handle more complex cases.
|
|
||||||
|
|
||||||
See PR for an example.
|
|
||||||
|
|
||||||
Thanks to [@yobert](https://github.com/yobert) for the fix.
|
|
||||||
|
|
||||||
### [1.7.5](https://github.com/magiconair/properties/tree/v1.7.5) - 13 Feb 2018
|
|
||||||
|
|
||||||
* [PR #28](https://github.com/magiconair/properties/pull/28): Support duplicate expansions in the same value
|
|
||||||
|
|
||||||
Values which expand the same key multiple times (e.g. `key=${a} ${a}`) will no longer fail
|
|
||||||
with a `circular reference error`.
|
|
||||||
|
|
||||||
Thanks to [@yobert](https://github.com/yobert) for the fix.
|
|
||||||
|
|
||||||
### [1.7.4](https://github.com/magiconair/properties/tree/v1.7.4) - 31 Oct 2017
|
|
||||||
|
|
||||||
* [Issue #23](https://github.com/magiconair/properties/issues/23): Ignore blank lines with whitespaces
|
|
||||||
|
|
||||||
* [PR #24](https://github.com/magiconair/properties/pull/24): Update keys when DisableExpansion is enabled
|
|
||||||
|
|
||||||
Thanks to [@mgurov](https://github.com/mgurov) for the fix.
|
|
||||||
|
|
||||||
### [1.7.3](https://github.com/magiconair/properties/tree/v1.7.3) - 10 Jul 2017
|
|
||||||
|
|
||||||
* [Issue #17](https://github.com/magiconair/properties/issues/17): Add [SetValue()](http://godoc.org/github.com/magiconair/properties#Properties.SetValue) method to set values generically
|
|
||||||
* [Issue #22](https://github.com/magiconair/properties/issues/22): Add [LoadMap()](http://godoc.org/github.com/magiconair/properties#LoadMap) function to load properties from a string map
|
|
||||||
|
|
||||||
### [1.7.2](https://github.com/magiconair/properties/tree/v1.7.2) - 20 Mar 2017
|
|
||||||
|
|
||||||
* [Issue #15](https://github.com/magiconair/properties/issues/15): Drop gocheck dependency
|
|
||||||
* [PR #21](https://github.com/magiconair/properties/pull/21): Add [Map()](http://godoc.org/github.com/magiconair/properties#Properties.Map) and [FilterFunc()](http://godoc.org/github.com/magiconair/properties#Properties.FilterFunc)
|
|
||||||
|
|
||||||
### [1.7.1](https://github.com/magiconair/properties/tree/v1.7.1) - 13 Jan 2017
|
|
||||||
|
|
||||||
* [Issue #14](https://github.com/magiconair/properties/issues/14): Decouple TestLoadExpandedFile from `$USER`
|
|
||||||
* [PR #12](https://github.com/magiconair/properties/pull/12): Load from files and URLs
|
|
||||||
* [PR #16](https://github.com/magiconair/properties/pull/16): Keep gofmt happy
|
|
||||||
* [PR #18](https://github.com/magiconair/properties/pull/18): Fix Delete() function
|
|
||||||
|
|
||||||
### [1.7.0](https://github.com/magiconair/properties/tree/v1.7.0) - 20 Mar 2016
|
|
||||||
|
|
||||||
* [Issue #10](https://github.com/magiconair/properties/issues/10): Add [LoadURL,LoadURLs,MustLoadURL,MustLoadURLs](http://godoc.org/github.com/magiconair/properties#LoadURL) method to load properties from a URL.
|
|
||||||
* [Issue #11](https://github.com/magiconair/properties/issues/11): Add [LoadString,MustLoadString](http://godoc.org/github.com/magiconair/properties#LoadString) method to load properties from an UTF8 string.
|
|
||||||
* [PR #8](https://github.com/magiconair/properties/pull/8): Add [MustFlag](http://godoc.org/github.com/magiconair/properties#Properties.MustFlag) method to provide overrides via command line flags. (@pascaldekloe)
|
|
||||||
|
|
||||||
### [1.6.0](https://github.com/magiconair/properties/tree/v1.6.0) - 11 Dec 2015
|
|
||||||
|
|
||||||
* Add [Decode](http://godoc.org/github.com/magiconair/properties#Properties.Decode) method to populate struct from properties via tags.
|
|
||||||
|
|
||||||
### [1.5.6](https://github.com/magiconair/properties/tree/v1.5.6) - 18 Oct 2015
|
|
||||||
|
|
||||||
* Vendored in gopkg.in/check.v1
|
|
||||||
|
|
||||||
### [1.5.5](https://github.com/magiconair/properties/tree/v1.5.5) - 31 Jul 2015
|
|
||||||
|
|
||||||
* [PR #6](https://github.com/magiconair/properties/pull/6): Add [Delete](http://godoc.org/github.com/magiconair/properties#Properties.Delete) method to remove keys including comments. (@gerbenjacobs)
|
|
||||||
|
|
||||||
### [1.5.4](https://github.com/magiconair/properties/tree/v1.5.4) - 23 Jun 2015
|
|
||||||
|
|
||||||
* [Issue #5](https://github.com/magiconair/properties/issues/5): Allow disabling of property expansion [DisableExpansion](http://godoc.org/github.com/magiconair/properties#Properties.DisableExpansion). When property expansion is disabled Properties become a simple key/value store and don't check for circular references.
|
|
||||||
|
|
||||||
### [1.5.3](https://github.com/magiconair/properties/tree/v1.5.3) - 02 Jun 2015
|
|
||||||
|
|
||||||
* [Issue #4](https://github.com/magiconair/properties/issues/4): Maintain key order in [Filter()](http://godoc.org/github.com/magiconair/properties#Properties.Filter), [FilterPrefix()](http://godoc.org/github.com/magiconair/properties#Properties.FilterPrefix) and [FilterRegexp()](http://godoc.org/github.com/magiconair/properties#Properties.FilterRegexp)
|
|
||||||
|
|
||||||
### [1.5.2](https://github.com/magiconair/properties/tree/v1.5.2) - 10 Apr 2015
|
|
||||||
|
|
||||||
* [Issue #3](https://github.com/magiconair/properties/issues/3): Don't print comments in [WriteComment()](http://godoc.org/github.com/magiconair/properties#Properties.WriteComment) if they are all empty
|
|
||||||
* Add clickable links to README
|
|
||||||
|
|
||||||
### [1.5.1](https://github.com/magiconair/properties/tree/v1.5.1) - 08 Dec 2014
|
|
||||||
|
|
||||||
* Added [GetParsedDuration()](http://godoc.org/github.com/magiconair/properties#Properties.GetParsedDuration) and [MustGetParsedDuration()](http://godoc.org/github.com/magiconair/properties#Properties.MustGetParsedDuration) for values specified compatible with
|
|
||||||
[time.ParseDuration()](http://golang.org/pkg/time/#ParseDuration).
|
|
||||||
|
|
||||||
### [1.5.0](https://github.com/magiconair/properties/tree/v1.5.0) - 18 Nov 2014
|
|
||||||
|
|
||||||
* Added support for single and multi-line comments (reading, writing and updating)
|
|
||||||
* The order of keys is now preserved
|
|
||||||
* Calling [Set()](http://godoc.org/github.com/magiconair/properties#Properties.Set) with an empty key now silently ignores the call and does not create a new entry
|
|
||||||
* Added a [MustSet()](http://godoc.org/github.com/magiconair/properties#Properties.MustSet) method
|
|
||||||
* Migrated test library from launchpad.net/gocheck to [gopkg.in/check.v1](http://gopkg.in/check.v1)
|
|
||||||
|
|
||||||
### [1.4.2](https://github.com/magiconair/properties/tree/v1.4.2) - 15 Nov 2014
|
|
||||||
|
|
||||||
* [Issue #2](https://github.com/magiconair/properties/issues/2): Fixed goroutine leak in parser which created two lexers but cleaned up only one
|
|
||||||
|
|
||||||
### [1.4.1](https://github.com/magiconair/properties/tree/v1.4.1) - 13 Nov 2014
|
|
||||||
|
|
||||||
* [Issue #1](https://github.com/magiconair/properties/issues/1): Fixed bug in Keys() method which returned an empty string
|
|
||||||
|
|
||||||
### [1.4.0](https://github.com/magiconair/properties/tree/v1.4.0) - 23 Sep 2014
|
|
||||||
|
|
||||||
* Added [Keys()](http://godoc.org/github.com/magiconair/properties#Properties.Keys) to get the keys
|
|
||||||
* Added [Filter()](http://godoc.org/github.com/magiconair/properties#Properties.Filter), [FilterRegexp()](http://godoc.org/github.com/magiconair/properties#Properties.FilterRegexp) and [FilterPrefix()](http://godoc.org/github.com/magiconair/properties#Properties.FilterPrefix) to get a subset of the properties
|
|
||||||
|
|
||||||
### [1.3.0](https://github.com/magiconair/properties/tree/v1.3.0) - 18 Mar 2014
|
|
||||||
|
|
||||||
* Added support for time.Duration
|
|
||||||
* Made MustXXX() failure beha[ior configurable (log.Fatal, panic](https://github.com/magiconair/properties/tree/vior configurable (log.Fatal, panic) - custom)
|
|
||||||
* Changed default of MustXXX() failure from panic to log.Fatal
|
|
||||||
|
|
||||||
### [1.2.0](https://github.com/magiconair/properties/tree/v1.2.0) - 05 Mar 2014
|
|
||||||
|
|
||||||
* Added MustGet... functions
|
|
||||||
* Added support for int and uint with range checks on 32 bit platforms
|
|
||||||
|
|
||||||
### [1.1.0](https://github.com/magiconair/properties/tree/v1.1.0) - 20 Jan 2014
|
|
||||||
|
|
||||||
* Renamed from goproperties to properties
|
|
||||||
* Added support for expansion of environment vars in
|
|
||||||
filenames and value expressions
|
|
||||||
* Fixed bug where value expressions were not at the
|
|
||||||
start of the string
|
|
||||||
|
|
||||||
### [1.0.0](https://github.com/magiconair/properties/tree/v1.0.0) - 7 Jan 2014
|
|
||||||
|
|
||||||
* Initial release
|
|
129
vendor/github.com/magiconair/properties/README.md
generated
vendored
129
vendor/github.com/magiconair/properties/README.md
generated
vendored
|
@ -1,129 +0,0 @@
|
||||||
[![](https://img.shields.io/github/tag/magiconair/properties.svg?style=flat-square&label=release)](https://github.com/magiconair/properties/releases)
|
|
||||||
[![Travis CI Status](https://img.shields.io/travis/magiconair/properties.svg?branch=master&style=flat-square&label=travis)](https://travis-ci.org/magiconair/properties)
|
|
||||||
[![Codeship CI Status](https://img.shields.io/codeship/16aaf660-f615-0135-b8f0-7e33b70920c0/master.svg?label=codeship&style=flat-square)](https://app.codeship.com/projects/274177")
|
|
||||||
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg?style=flat-square)](https://raw.githubusercontent.com/magiconair/properties/master/LICENSE)
|
|
||||||
[![GoDoc](http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](http://godoc.org/github.com/magiconair/properties)
|
|
||||||
|
|
||||||
# Overview
|
|
||||||
|
|
||||||
#### Please run `git pull --tags` to update the tags. See [below](#updated-git-tags) why.
|
|
||||||
|
|
||||||
properties is a Go library for reading and writing properties files.
|
|
||||||
|
|
||||||
It supports reading from multiple files or URLs and Spring style recursive
|
|
||||||
property expansion of expressions like `${key}` to their corresponding value.
|
|
||||||
Value expressions can refer to other keys like in `${key}` or to environment
|
|
||||||
variables like in `${USER}`. Filenames can also contain environment variables
|
|
||||||
like in `/home/${USER}/myapp.properties`.
|
|
||||||
|
|
||||||
Properties can be decoded into structs, maps, arrays and values through
|
|
||||||
struct tags.
|
|
||||||
|
|
||||||
Comments and the order of keys are preserved. Comments can be modified
|
|
||||||
and can be written to the output.
|
|
||||||
|
|
||||||
The properties library supports both ISO-8859-1 and UTF-8 encoded data.
|
|
||||||
|
|
||||||
Starting from version 1.3.0 the behavior of the MustXXX() functions is
|
|
||||||
configurable by providing a custom `ErrorHandler` function. The default has
|
|
||||||
changed from `panic` to `log.Fatal` but this is configurable and custom
|
|
||||||
error handling functions can be provided. See the package documentation for
|
|
||||||
details.
|
|
||||||
|
|
||||||
Read the full documentation on [GoDoc](https://godoc.org/github.com/magiconair/properties) [![GoDoc](https://godoc.org/github.com/magiconair/properties?status.png)](https://godoc.org/github.com/magiconair/properties)
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
"flag"
|
|
||||||
"github.com/magiconair/properties"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
// init from a file
|
|
||||||
p := properties.MustLoadFile("${HOME}/config.properties", properties.UTF8)
|
|
||||||
|
|
||||||
// or multiple files
|
|
||||||
p = properties.MustLoadFiles([]string{
|
|
||||||
"${HOME}/config.properties",
|
|
||||||
"${HOME}/config-${USER}.properties",
|
|
||||||
}, properties.UTF8, true)
|
|
||||||
|
|
||||||
// or from a map
|
|
||||||
p = properties.LoadMap(map[string]string{"key": "value", "abc": "def"})
|
|
||||||
|
|
||||||
// or from a string
|
|
||||||
p = properties.MustLoadString("key=value\nabc=def")
|
|
||||||
|
|
||||||
// or from a URL
|
|
||||||
p = properties.MustLoadURL("http://host/path")
|
|
||||||
|
|
||||||
// or from multiple URLs
|
|
||||||
p = properties.MustLoadURL([]string{
|
|
||||||
"http://host/config",
|
|
||||||
"http://host/config-${USER}",
|
|
||||||
}, true)
|
|
||||||
|
|
||||||
// or from flags
|
|
||||||
p.MustFlag(flag.CommandLine)
|
|
||||||
|
|
||||||
// get values through getters
|
|
||||||
host := p.MustGetString("host")
|
|
||||||
port := p.GetInt("port", 8080)
|
|
||||||
|
|
||||||
// or through Decode
|
|
||||||
type Config struct {
|
|
||||||
Host string `properties:"host"`
|
|
||||||
Port int `properties:"port,default=9000"`
|
|
||||||
Accept []string `properties:"accept,default=image/png;image;gif"`
|
|
||||||
Timeout time.Duration `properties:"timeout,default=5s"`
|
|
||||||
}
|
|
||||||
var cfg Config
|
|
||||||
if err := p.Decode(&cfg); err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation and Upgrade
|
|
||||||
|
|
||||||
```
|
|
||||||
$ go get -u github.com/magiconair/properties
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
2 clause BSD license. See [LICENSE](https://github.com/magiconair/properties/blob/master/LICENSE) file for details.
|
|
||||||
|
|
||||||
## ToDo
|
|
||||||
|
|
||||||
* Dump contents with passwords and secrets obscured
|
|
||||||
|
|
||||||
## Updated Git tags
|
|
||||||
|
|
||||||
#### 13 Feb 2018
|
|
||||||
|
|
||||||
I realized that all of the git tags I had pushed before v1.7.5 were lightweight tags
|
|
||||||
and I've only recently learned that this doesn't play well with `git describe` 😞
|
|
||||||
|
|
||||||
I have replaced all lightweight tags with signed tags using this script which should
|
|
||||||
retain the commit date, name and email address. Please run `git pull --tags` to update them.
|
|
||||||
|
|
||||||
Worst case you have to reclone the repo.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
#!/bin/bash
|
|
||||||
tag=$1
|
|
||||||
echo "Updating $tag"
|
|
||||||
date=$(git show ${tag}^0 --format=%aD | head -1)
|
|
||||||
email=$(git show ${tag}^0 --format=%aE | head -1)
|
|
||||||
name=$(git show ${tag}^0 --format=%aN | head -1)
|
|
||||||
GIT_COMMITTER_DATE="$date" GIT_COMMITTER_NAME="$name" GIT_COMMITTER_EMAIL="$email" git tag -s -f ${tag} ${tag}^0 -m ${tag}
|
|
||||||
```
|
|
||||||
|
|
||||||
I apologize for the inconvenience.
|
|
||||||
|
|
||||||
Frank
|
|
||||||
|
|
8
vendor/github.com/mattn/go-runewidth/.travis.yml
generated
vendored
8
vendor/github.com/mattn/go-runewidth/.travis.yml
generated
vendored
|
@ -1,8 +0,0 @@
|
||||||
language: go
|
|
||||||
go:
|
|
||||||
- tip
|
|
||||||
before_install:
|
|
||||||
- go get github.com/mattn/goveralls
|
|
||||||
- go get golang.org/x/tools/cmd/cover
|
|
||||||
script:
|
|
||||||
- $HOME/gopath/bin/goveralls -repotoken lAKAWPzcGsD3A8yBX3BGGtRUdJ6CaGERL
|
|
27
vendor/github.com/mattn/go-runewidth/README.mkd
generated
vendored
27
vendor/github.com/mattn/go-runewidth/README.mkd
generated
vendored
|
@ -1,27 +0,0 @@
|
||||||
go-runewidth
|
|
||||||
============
|
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/mattn/go-runewidth.png?branch=master)](https://travis-ci.org/mattn/go-runewidth)
|
|
||||||
[![Coverage Status](https://coveralls.io/repos/mattn/go-runewidth/badge.png?branch=HEAD)](https://coveralls.io/r/mattn/go-runewidth?branch=HEAD)
|
|
||||||
[![GoDoc](https://godoc.org/github.com/mattn/go-runewidth?status.svg)](http://godoc.org/github.com/mattn/go-runewidth)
|
|
||||||
[![Go Report Card](https://goreportcard.com/badge/github.com/mattn/go-runewidth)](https://goreportcard.com/report/github.com/mattn/go-runewidth)
|
|
||||||
|
|
||||||
Provides functions to get fixed width of the character or string.
|
|
||||||
|
|
||||||
Usage
|
|
||||||
-----
|
|
||||||
|
|
||||||
```go
|
|
||||||
runewidth.StringWidth("つのだ☆HIRO") == 12
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Author
|
|
||||||
------
|
|
||||||
|
|
||||||
Yasuhiro Matsumoto
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
under the MIT License: http://mattn.mit-license.org/2013
|
|
14
vendor/github.com/mitchellh/go-homedir/README.md
generated
vendored
14
vendor/github.com/mitchellh/go-homedir/README.md
generated
vendored
|
@ -1,14 +0,0 @@
|
||||||
# go-homedir
|
|
||||||
|
|
||||||
This is a Go library for detecting the user's home directory without
|
|
||||||
the use of cgo, so the library can be used in cross-compilation environments.
|
|
||||||
|
|
||||||
Usage is incredibly simple, just call `homedir.Dir()` to get the home directory
|
|
||||||
for a user, and `homedir.Expand()` to expand the `~` in a path to the home
|
|
||||||
directory.
|
|
||||||
|
|
||||||
**Why not just use `os/user`?** The built-in `os/user` package requires
|
|
||||||
cgo on Darwin systems. This means that any Go code that uses that package
|
|
||||||
cannot cross compile. But 99% of the time the use for `os/user` is just to
|
|
||||||
retrieve the home directory, which we can do for the current user without
|
|
||||||
cgo. This library does that, enabling cross-compilation.
|
|
8
vendor/github.com/mitchellh/mapstructure/.travis.yml
generated
vendored
8
vendor/github.com/mitchellh/mapstructure/.travis.yml
generated
vendored
|
@ -1,8 +0,0 @@
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.9.x
|
|
||||||
- tip
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go test
|
|
46
vendor/github.com/mitchellh/mapstructure/README.md
generated
vendored
46
vendor/github.com/mitchellh/mapstructure/README.md
generated
vendored
|
@ -1,46 +0,0 @@
|
||||||
# mapstructure [![Godoc](https://godoc.org/github.com/mitchellh/mapstructure?status.svg)](https://godoc.org/github.com/mitchellh/mapstructure)
|
|
||||||
|
|
||||||
mapstructure is a Go library for decoding generic map values to structures
|
|
||||||
and vice versa, while providing helpful error handling.
|
|
||||||
|
|
||||||
This library is most useful when decoding values from some data stream (JSON,
|
|
||||||
Gob, etc.) where you don't _quite_ know the structure of the underlying data
|
|
||||||
until you read a part of it. You can therefore read a `map[string]interface{}`
|
|
||||||
and use this library to decode it into the proper underlying native Go
|
|
||||||
structure.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Standard `go get`:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ go get github.com/mitchellh/mapstructure
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage & Example
|
|
||||||
|
|
||||||
For usage and examples see the [Godoc](http://godoc.org/github.com/mitchellh/mapstructure).
|
|
||||||
|
|
||||||
The `Decode` function has examples associated with it there.
|
|
||||||
|
|
||||||
## But Why?!
|
|
||||||
|
|
||||||
Go offers fantastic standard libraries for decoding formats such as JSON.
|
|
||||||
The standard method is to have a struct pre-created, and populate that struct
|
|
||||||
from the bytes of the encoded format. This is great, but the problem is if
|
|
||||||
you have configuration or an encoding that changes slightly depending on
|
|
||||||
specific fields. For example, consider this JSON:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "person",
|
|
||||||
"name": "Mitchell"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Perhaps we can't populate a specific structure without first reading
|
|
||||||
the "type" field from the JSON. We could always do two passes over the
|
|
||||||
decoding of the JSON (reading the "type" first, and the rest later).
|
|
||||||
However, it is much simpler to just decode this into a `map[string]interface{}`
|
|
||||||
structure, read the "type" key, then use something like this library
|
|
||||||
to decode it into the proper structure.
|
|
15
vendor/github.com/olekukonko/tablewriter/.gitignore
generated
vendored
15
vendor/github.com/olekukonko/tablewriter/.gitignore
generated
vendored
|
@ -1,15 +0,0 @@
|
||||||
# Created by .ignore support plugin (hsz.mobi)
|
|
||||||
### Go template
|
|
||||||
# Binaries for programs and plugins
|
|
||||||
*.exe
|
|
||||||
*.exe~
|
|
||||||
*.dll
|
|
||||||
*.so
|
|
||||||
*.dylib
|
|
||||||
|
|
||||||
# Test binary, build with `go test -c`
|
|
||||||
*.test
|
|
||||||
|
|
||||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
|
||||||
*.out
|
|
||||||
|
|
12
vendor/github.com/olekukonko/tablewriter/.travis.yml
generated
vendored
12
vendor/github.com/olekukonko/tablewriter/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.1
|
|
||||||
- 1.2
|
|
||||||
- 1.3
|
|
||||||
- 1.4
|
|
||||||
- 1.5
|
|
||||||
- 1.6
|
|
||||||
- 1.7
|
|
||||||
- 1.8
|
|
||||||
- tip
|
|
277
vendor/github.com/olekukonko/tablewriter/README.md
generated
vendored
277
vendor/github.com/olekukonko/tablewriter/README.md
generated
vendored
|
@ -1,277 +0,0 @@
|
||||||
ASCII Table Writer
|
|
||||||
=========
|
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/olekukonko/tablewriter.png?branch=master)](https://travis-ci.org/olekukonko/tablewriter)
|
|
||||||
[![Total views](https://img.shields.io/sourcegraph/rrc/github.com/olekukonko/tablewriter.svg)](https://sourcegraph.com/github.com/olekukonko/tablewriter)
|
|
||||||
[![Godoc](https://godoc.org/github.com/olekukonko/tablewriter?status.svg)](https://godoc.org/github.com/olekukonko/tablewriter)
|
|
||||||
|
|
||||||
Generate ASCII table on the fly ... Installation is simple as
|
|
||||||
|
|
||||||
go get github.com/olekukonko/tablewriter
|
|
||||||
|
|
||||||
|
|
||||||
#### Features
|
|
||||||
- Automatic Padding
|
|
||||||
- Support Multiple Lines
|
|
||||||
- Supports Alignment
|
|
||||||
- Support Custom Separators
|
|
||||||
- Automatic Alignment of numbers & percentage
|
|
||||||
- Write directly to http , file etc via `io.Writer`
|
|
||||||
- Read directly from CSV file
|
|
||||||
- Optional row line via `SetRowLine`
|
|
||||||
- Normalise table header
|
|
||||||
- Make CSV Headers optional
|
|
||||||
- Enable or disable table border
|
|
||||||
- Set custom footer support
|
|
||||||
- Optional identical cells merging
|
|
||||||
- Set custom caption
|
|
||||||
- Optional reflowing of paragrpahs in multi-line cells.
|
|
||||||
|
|
||||||
#### Example 1 - Basic
|
|
||||||
```go
|
|
||||||
data := [][]string{
|
|
||||||
[]string{"A", "The Good", "500"},
|
|
||||||
[]string{"B", "The Very very Bad Man", "288"},
|
|
||||||
[]string{"C", "The Ugly", "120"},
|
|
||||||
[]string{"D", "The Gopher", "800"},
|
|
||||||
}
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.SetHeader([]string{"Name", "Sign", "Rating"})
|
|
||||||
|
|
||||||
for _, v := range data {
|
|
||||||
table.Append(v)
|
|
||||||
}
|
|
||||||
table.Render() // Send output
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Output 1
|
|
||||||
```
|
|
||||||
+------+-----------------------+--------+
|
|
||||||
| NAME | SIGN | RATING |
|
|
||||||
+------+-----------------------+--------+
|
|
||||||
| A | The Good | 500 |
|
|
||||||
| B | The Very very Bad Man | 288 |
|
|
||||||
| C | The Ugly | 120 |
|
|
||||||
| D | The Gopher | 800 |
|
|
||||||
+------+-----------------------+--------+
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Example 2 - Without Border / Footer / Bulk Append
|
|
||||||
```go
|
|
||||||
data := [][]string{
|
|
||||||
[]string{"1/1/2014", "Domain name", "2233", "$10.98"},
|
|
||||||
[]string{"1/1/2014", "January Hosting", "2233", "$54.95"},
|
|
||||||
[]string{"1/4/2014", "February Hosting", "2233", "$51.00"},
|
|
||||||
[]string{"1/4/2014", "February Extra Bandwidth", "2233", "$30.00"},
|
|
||||||
}
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.SetHeader([]string{"Date", "Description", "CV2", "Amount"})
|
|
||||||
table.SetFooter([]string{"", "", "Total", "$146.93"}) // Add Footer
|
|
||||||
table.SetBorder(false) // Set Border to false
|
|
||||||
table.AppendBulk(data) // Add Bulk Data
|
|
||||||
table.Render()
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Output 2
|
|
||||||
```
|
|
||||||
|
|
||||||
DATE | DESCRIPTION | CV2 | AMOUNT
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
1/1/2014 | Domain name | 2233 | $10.98
|
|
||||||
1/1/2014 | January Hosting | 2233 | $54.95
|
|
||||||
1/4/2014 | February Hosting | 2233 | $51.00
|
|
||||||
1/4/2014 | February Extra Bandwidth | 2233 | $30.00
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
TOTAL | $146 93
|
|
||||||
+-------+---------+
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
#### Example 3 - CSV
|
|
||||||
```go
|
|
||||||
table, _ := tablewriter.NewCSV(os.Stdout, "testdata/test_info.csv", true)
|
|
||||||
table.SetAlignment(tablewriter.ALIGN_LEFT) // Set Alignment
|
|
||||||
table.Render()
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Output 3
|
|
||||||
```
|
|
||||||
+----------+--------------+------+-----+---------+----------------+
|
|
||||||
| FIELD | TYPE | NULL | KEY | DEFAULT | EXTRA |
|
|
||||||
+----------+--------------+------+-----+---------+----------------+
|
|
||||||
| user_id | smallint(5) | NO | PRI | NULL | auto_increment |
|
|
||||||
| username | varchar(10) | NO | | NULL | |
|
|
||||||
| password | varchar(100) | NO | | NULL | |
|
|
||||||
+----------+--------------+------+-----+---------+----------------+
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Example 4 - Custom Separator
|
|
||||||
```go
|
|
||||||
table, _ := tablewriter.NewCSV(os.Stdout, "testdata/test.csv", true)
|
|
||||||
table.SetRowLine(true) // Enable row line
|
|
||||||
|
|
||||||
// Change table lines
|
|
||||||
table.SetCenterSeparator("*")
|
|
||||||
table.SetColumnSeparator("‡")
|
|
||||||
table.SetRowSeparator("-")
|
|
||||||
|
|
||||||
table.SetAlignment(tablewriter.ALIGN_LEFT)
|
|
||||||
table.Render()
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Output 4
|
|
||||||
```
|
|
||||||
*------------*-----------*---------*
|
|
||||||
╪ FIRST NAME ╪ LAST NAME ╪ SSN ╪
|
|
||||||
*------------*-----------*---------*
|
|
||||||
╪ John ╪ Barry ╪ 123456 ╪
|
|
||||||
*------------*-----------*---------*
|
|
||||||
╪ Kathy ╪ Smith ╪ 687987 ╪
|
|
||||||
*------------*-----------*---------*
|
|
||||||
╪ Bob ╪ McCornick ╪ 3979870 ╪
|
|
||||||
*------------*-----------*---------*
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Example 5 - Markdown Format
|
|
||||||
```go
|
|
||||||
data := [][]string{
|
|
||||||
[]string{"1/1/2014", "Domain name", "2233", "$10.98"},
|
|
||||||
[]string{"1/1/2014", "January Hosting", "2233", "$54.95"},
|
|
||||||
[]string{"1/4/2014", "February Hosting", "2233", "$51.00"},
|
|
||||||
[]string{"1/4/2014", "February Extra Bandwidth", "2233", "$30.00"},
|
|
||||||
}
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.SetHeader([]string{"Date", "Description", "CV2", "Amount"})
|
|
||||||
table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
|
|
||||||
table.SetCenterSeparator("|")
|
|
||||||
table.AppendBulk(data) // Add Bulk Data
|
|
||||||
table.Render()
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Output 5
|
|
||||||
```
|
|
||||||
| DATE | DESCRIPTION | CV2 | AMOUNT |
|
|
||||||
|----------|--------------------------|------|--------|
|
|
||||||
| 1/1/2014 | Domain name | 2233 | $10.98 |
|
|
||||||
| 1/1/2014 | January Hosting | 2233 | $54.95 |
|
|
||||||
| 1/4/2014 | February Hosting | 2233 | $51.00 |
|
|
||||||
| 1/4/2014 | February Extra Bandwidth | 2233 | $30.00 |
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Example 6 - Identical cells merging
|
|
||||||
```go
|
|
||||||
data := [][]string{
|
|
||||||
[]string{"1/1/2014", "Domain name", "1234", "$10.98"},
|
|
||||||
[]string{"1/1/2014", "January Hosting", "2345", "$54.95"},
|
|
||||||
[]string{"1/4/2014", "February Hosting", "3456", "$51.00"},
|
|
||||||
[]string{"1/4/2014", "February Extra Bandwidth", "4567", "$30.00"},
|
|
||||||
}
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.SetHeader([]string{"Date", "Description", "CV2", "Amount"})
|
|
||||||
table.SetFooter([]string{"", "", "Total", "$146.93"})
|
|
||||||
table.SetAutoMergeCells(true)
|
|
||||||
table.SetRowLine(true)
|
|
||||||
table.AppendBulk(data)
|
|
||||||
table.Render()
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Output 6
|
|
||||||
```
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
| DATE | DESCRIPTION | CV2 | AMOUNT |
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
| 1/1/2014 | Domain name | 1234 | $10.98 |
|
|
||||||
+ +--------------------------+-------+---------+
|
|
||||||
| | January Hosting | 2345 | $54.95 |
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
| 1/4/2014 | February Hosting | 3456 | $51.00 |
|
|
||||||
+ +--------------------------+-------+---------+
|
|
||||||
| | February Extra Bandwidth | 4567 | $30.00 |
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
| TOTAL | $146 93 |
|
|
||||||
+----------+--------------------------+-------+---------+
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
#### Table with color
|
|
||||||
```go
|
|
||||||
data := [][]string{
|
|
||||||
[]string{"1/1/2014", "Domain name", "2233", "$10.98"},
|
|
||||||
[]string{"1/1/2014", "January Hosting", "2233", "$54.95"},
|
|
||||||
[]string{"1/4/2014", "February Hosting", "2233", "$51.00"},
|
|
||||||
[]string{"1/4/2014", "February Extra Bandwidth", "2233", "$30.00"},
|
|
||||||
}
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.SetHeader([]string{"Date", "Description", "CV2", "Amount"})
|
|
||||||
table.SetFooter([]string{"", "", "Total", "$146.93"}) // Add Footer
|
|
||||||
table.SetBorder(false) // Set Border to false
|
|
||||||
|
|
||||||
table.SetHeaderColor(tablewriter.Colors{tablewriter.Bold, tablewriter.BgGreenColor},
|
|
||||||
tablewriter.Colors{tablewriter.FgHiRedColor, tablewriter.Bold, tablewriter.BgBlackColor},
|
|
||||||
tablewriter.Colors{tablewriter.BgRedColor, tablewriter.FgWhiteColor},
|
|
||||||
tablewriter.Colors{tablewriter.BgCyanColor, tablewriter.FgWhiteColor})
|
|
||||||
|
|
||||||
table.SetColumnColor(tablewriter.Colors{tablewriter.Bold, tablewriter.FgHiBlackColor},
|
|
||||||
tablewriter.Colors{tablewriter.Bold, tablewriter.FgHiRedColor},
|
|
||||||
tablewriter.Colors{tablewriter.Bold, tablewriter.FgHiBlackColor},
|
|
||||||
tablewriter.Colors{tablewriter.Bold, tablewriter.FgBlackColor})
|
|
||||||
|
|
||||||
table.SetFooterColor(tablewriter.Colors{}, tablewriter.Colors{},
|
|
||||||
tablewriter.Colors{tablewriter.Bold},
|
|
||||||
tablewriter.Colors{tablewriter.FgHiRedColor})
|
|
||||||
|
|
||||||
table.AppendBulk(data)
|
|
||||||
table.Render()
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Table with color Output
|
|
||||||
![Table with Color](https://cloud.githubusercontent.com/assets/6460392/21101956/bbc7b356-c0a1-11e6-9f36-dba694746efc.png)
|
|
||||||
|
|
||||||
#### Example 6 - Set table caption
|
|
||||||
```go
|
|
||||||
data := [][]string{
|
|
||||||
[]string{"A", "The Good", "500"},
|
|
||||||
[]string{"B", "The Very very Bad Man", "288"},
|
|
||||||
[]string{"C", "The Ugly", "120"},
|
|
||||||
[]string{"D", "The Gopher", "800"},
|
|
||||||
}
|
|
||||||
|
|
||||||
table := tablewriter.NewWriter(os.Stdout)
|
|
||||||
table.SetHeader([]string{"Name", "Sign", "Rating"})
|
|
||||||
table.SetCaption(true, "Movie ratings.")
|
|
||||||
|
|
||||||
for _, v := range data {
|
|
||||||
table.Append(v)
|
|
||||||
}
|
|
||||||
table.Render() // Send output
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: Caption text will wrap with total width of rendered table.
|
|
||||||
|
|
||||||
##### Output 6
|
|
||||||
```
|
|
||||||
+------+-----------------------+--------+
|
|
||||||
| NAME | SIGN | RATING |
|
|
||||||
+------+-----------------------+--------+
|
|
||||||
| A | The Good | 500 |
|
|
||||||
| B | The Very very Bad Man | 288 |
|
|
||||||
| C | The Ugly | 120 |
|
|
||||||
| D | The Gopher | 800 |
|
|
||||||
+------+-----------------------+--------+
|
|
||||||
Movie ratings.
|
|
||||||
```
|
|
||||||
|
|
||||||
#### TODO
|
|
||||||
- ~~Import Directly from CSV~~ - `done`
|
|
||||||
- ~~Support for `SetFooter`~~ - `done`
|
|
||||||
- ~~Support for `SetBorder`~~ - `done`
|
|
||||||
- ~~Support table with uneven rows~~ - `done`
|
|
||||||
- ~~Support custom alignment~~
|
|
||||||
- General Improvement & Optimisation
|
|
||||||
- `NewHTML` Parse table from HTML
|
|
2
vendor/github.com/pelletier/go-toml/.gitignore
generated
vendored
2
vendor/github.com/pelletier/go-toml/.gitignore
generated
vendored
|
@ -1,2 +0,0 @@
|
||||||
test_program/test_program_bin
|
|
||||||
fuzz/
|
|
22
vendor/github.com/pelletier/go-toml/.travis.yml
generated
vendored
22
vendor/github.com/pelletier/go-toml/.travis.yml
generated
vendored
|
@ -1,22 +0,0 @@
|
||||||
sudo: false
|
|
||||||
language: go
|
|
||||||
go:
|
|
||||||
- 1.8.5
|
|
||||||
- 1.9.2
|
|
||||||
- tip
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
fast_finish: true
|
|
||||||
script:
|
|
||||||
- if [ -n "$(go fmt ./...)" ]; then exit 1; fi
|
|
||||||
- ./test.sh
|
|
||||||
- ./benchmark.sh $TRAVIS_BRANCH https://github.com/$TRAVIS_REPO_SLUG.git
|
|
||||||
before_install:
|
|
||||||
- go get github.com/axw/gocov/gocov
|
|
||||||
- go get github.com/mattn/goveralls
|
|
||||||
- if ! go get code.google.com/p/go.tools/cmd/cover; then go get golang.org/x/tools/cmd/cover; fi
|
|
||||||
branches:
|
|
||||||
only: [master]
|
|
||||||
after_success:
|
|
||||||
- $HOME/gopath/bin/goveralls -service=travis-ci -coverprofile=coverage.out -repotoken $COVERALLS_TOKEN
|
|
131
vendor/github.com/pelletier/go-toml/README.md
generated
vendored
131
vendor/github.com/pelletier/go-toml/README.md
generated
vendored
|
@ -1,131 +0,0 @@
|
||||||
# go-toml
|
|
||||||
|
|
||||||
Go library for the [TOML](https://github.com/mojombo/toml) format.
|
|
||||||
|
|
||||||
This library supports TOML version
|
|
||||||
[v0.4.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md)
|
|
||||||
|
|
||||||
[![GoDoc](https://godoc.org/github.com/pelletier/go-toml?status.svg)](http://godoc.org/github.com/pelletier/go-toml)
|
|
||||||
[![license](https://img.shields.io/github/license/pelletier/go-toml.svg)](https://github.com/pelletier/go-toml/blob/master/LICENSE)
|
|
||||||
[![Build Status](https://travis-ci.org/pelletier/go-toml.svg?branch=master)](https://travis-ci.org/pelletier/go-toml)
|
|
||||||
[![Coverage Status](https://coveralls.io/repos/github/pelletier/go-toml/badge.svg?branch=master)](https://coveralls.io/github/pelletier/go-toml?branch=master)
|
|
||||||
[![Go Report Card](https://goreportcard.com/badge/github.com/pelletier/go-toml)](https://goreportcard.com/report/github.com/pelletier/go-toml)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
Go-toml provides the following features for using data parsed from TOML documents:
|
|
||||||
|
|
||||||
* Load TOML documents from files and string data
|
|
||||||
* Easily navigate TOML structure using Tree
|
|
||||||
* Mashaling and unmarshaling to and from data structures
|
|
||||||
* Line & column position data for all parsed elements
|
|
||||||
* [Query support similar to JSON-Path](query/)
|
|
||||||
* Syntax errors contain line and column numbers
|
|
||||||
|
|
||||||
## Import
|
|
||||||
|
|
||||||
```go
|
|
||||||
import "github.com/pelletier/go-toml"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage example
|
|
||||||
|
|
||||||
Read a TOML document:
|
|
||||||
|
|
||||||
```go
|
|
||||||
config, _ := toml.Load(`
|
|
||||||
[postgres]
|
|
||||||
user = "pelletier"
|
|
||||||
password = "mypassword"`)
|
|
||||||
// retrieve data directly
|
|
||||||
user := config.Get("postgres.user").(string)
|
|
||||||
|
|
||||||
// or using an intermediate object
|
|
||||||
postgresConfig := config.Get("postgres").(*toml.Tree)
|
|
||||||
password := postgresConfig.Get("password").(string)
|
|
||||||
```
|
|
||||||
|
|
||||||
Or use Unmarshal:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type Postgres struct {
|
|
||||||
User string
|
|
||||||
Password string
|
|
||||||
}
|
|
||||||
type Config struct {
|
|
||||||
Postgres Postgres
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := []byte(`
|
|
||||||
[Postgres]
|
|
||||||
User = "pelletier"
|
|
||||||
Password = "mypassword"`)
|
|
||||||
|
|
||||||
config := Config{}
|
|
||||||
toml.Unmarshal(doc, &config)
|
|
||||||
fmt.Println("user=", config.Postgres.User)
|
|
||||||
```
|
|
||||||
|
|
||||||
Or use a query:
|
|
||||||
|
|
||||||
```go
|
|
||||||
// use a query to gather elements without walking the tree
|
|
||||||
q, _ := query.Compile("$..[user,password]")
|
|
||||||
results := q.Execute(config)
|
|
||||||
for ii, item := range results.Values() {
|
|
||||||
fmt.Println("Query result %d: %v", ii, item)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
The documentation and additional examples are available at
|
|
||||||
[godoc.org](http://godoc.org/github.com/pelletier/go-toml).
|
|
||||||
|
|
||||||
## Tools
|
|
||||||
|
|
||||||
Go-toml provides two handy command line tools:
|
|
||||||
|
|
||||||
* `tomll`: Reads TOML files and lint them.
|
|
||||||
|
|
||||||
```
|
|
||||||
go install github.com/pelletier/go-toml/cmd/tomll
|
|
||||||
tomll --help
|
|
||||||
```
|
|
||||||
* `tomljson`: Reads a TOML file and outputs its JSON representation.
|
|
||||||
|
|
||||||
```
|
|
||||||
go install github.com/pelletier/go-toml/cmd/tomljson
|
|
||||||
tomljson --help
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contribute
|
|
||||||
|
|
||||||
Feel free to report bugs and patches using GitHub's pull requests system on
|
|
||||||
[pelletier/go-toml](https://github.com/pelletier/go-toml). Any feedback would be
|
|
||||||
much appreciated!
|
|
||||||
|
|
||||||
### Run tests
|
|
||||||
|
|
||||||
You have to make sure two kind of tests run:
|
|
||||||
|
|
||||||
1. The Go unit tests
|
|
||||||
2. The TOML examples base
|
|
||||||
|
|
||||||
You can run both of them using `./test.sh`.
|
|
||||||
|
|
||||||
### Fuzzing
|
|
||||||
|
|
||||||
The script `./fuzz.sh` is available to
|
|
||||||
run [go-fuzz](https://github.com/dvyukov/go-fuzz) on go-toml.
|
|
||||||
|
|
||||||
## Versioning
|
|
||||||
|
|
||||||
Go-toml follows [Semantic Versioning](http://semver.org/). The supported version
|
|
||||||
of [TOML](https://github.com/toml-lang/toml) is indicated at the beginning of
|
|
||||||
this document. The last two major versions of Go are supported
|
|
||||||
(see [Go Release Policy](https://golang.org/doc/devel/release.html#policy)).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
The MIT License (MIT). Read [LICENSE](LICENSE).
|
|
164
vendor/github.com/pelletier/go-toml/benchmark.json
generated
vendored
164
vendor/github.com/pelletier/go-toml/benchmark.json
generated
vendored
|
@ -1,164 +0,0 @@
|
||||||
{
|
|
||||||
"array": {
|
|
||||||
"key1": [
|
|
||||||
1,
|
|
||||||
2,
|
|
||||||
3
|
|
||||||
],
|
|
||||||
"key2": [
|
|
||||||
"red",
|
|
||||||
"yellow",
|
|
||||||
"green"
|
|
||||||
],
|
|
||||||
"key3": [
|
|
||||||
[
|
|
||||||
1,
|
|
||||||
2
|
|
||||||
],
|
|
||||||
[
|
|
||||||
3,
|
|
||||||
4,
|
|
||||||
5
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"key4": [
|
|
||||||
[
|
|
||||||
1,
|
|
||||||
2
|
|
||||||
],
|
|
||||||
[
|
|
||||||
"a",
|
|
||||||
"b",
|
|
||||||
"c"
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"key5": [
|
|
||||||
1,
|
|
||||||
2,
|
|
||||||
3
|
|
||||||
],
|
|
||||||
"key6": [
|
|
||||||
1,
|
|
||||||
2
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"boolean": {
|
|
||||||
"False": false,
|
|
||||||
"True": true
|
|
||||||
},
|
|
||||||
"datetime": {
|
|
||||||
"key1": "1979-05-27T07:32:00Z",
|
|
||||||
"key2": "1979-05-27T00:32:00-07:00",
|
|
||||||
"key3": "1979-05-27T00:32:00.999999-07:00"
|
|
||||||
},
|
|
||||||
"float": {
|
|
||||||
"both": {
|
|
||||||
"key": 6.626e-34
|
|
||||||
},
|
|
||||||
"exponent": {
|
|
||||||
"key1": 5e+22,
|
|
||||||
"key2": 1000000,
|
|
||||||
"key3": -0.02
|
|
||||||
},
|
|
||||||
"fractional": {
|
|
||||||
"key1": 1,
|
|
||||||
"key2": 3.1415,
|
|
||||||
"key3": -0.01
|
|
||||||
},
|
|
||||||
"underscores": {
|
|
||||||
"key1": 9224617.445991227,
|
|
||||||
"key2": 1e+100
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"fruit": [{
|
|
||||||
"name": "apple",
|
|
||||||
"physical": {
|
|
||||||
"color": "red",
|
|
||||||
"shape": "round"
|
|
||||||
},
|
|
||||||
"variety": [{
|
|
||||||
"name": "red delicious"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "granny smith"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "banana",
|
|
||||||
"variety": [{
|
|
||||||
"name": "plantain"
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"integer": {
|
|
||||||
"key1": 99,
|
|
||||||
"key2": 42,
|
|
||||||
"key3": 0,
|
|
||||||
"key4": -17,
|
|
||||||
"underscores": {
|
|
||||||
"key1": 1000,
|
|
||||||
"key2": 5349221,
|
|
||||||
"key3": 12345
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"products": [{
|
|
||||||
"name": "Hammer",
|
|
||||||
"sku": 738594937
|
|
||||||
},
|
|
||||||
{},
|
|
||||||
{
|
|
||||||
"color": "gray",
|
|
||||||
"name": "Nail",
|
|
||||||
"sku": 284758393
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"string": {
|
|
||||||
"basic": {
|
|
||||||
"basic": "I'm a string. \"You can quote me\". Name\tJosé\nLocation\tSF."
|
|
||||||
},
|
|
||||||
"literal": {
|
|
||||||
"multiline": {
|
|
||||||
"lines": "The first newline is\ntrimmed in raw strings.\n All other whitespace\n is preserved.\n",
|
|
||||||
"regex2": "I [dw]on't need \\d{2} apples"
|
|
||||||
},
|
|
||||||
"quoted": "Tom \"Dubs\" Preston-Werner",
|
|
||||||
"regex": "\u003c\\i\\c*\\s*\u003e",
|
|
||||||
"winpath": "C:\\Users\\nodejs\\templates",
|
|
||||||
"winpath2": "\\\\ServerX\\admin$\\system32\\"
|
|
||||||
},
|
|
||||||
"multiline": {
|
|
||||||
"continued": {
|
|
||||||
"key1": "The quick brown fox jumps over the lazy dog.",
|
|
||||||
"key2": "The quick brown fox jumps over the lazy dog.",
|
|
||||||
"key3": "The quick brown fox jumps over the lazy dog."
|
|
||||||
},
|
|
||||||
"key1": "One\nTwo",
|
|
||||||
"key2": "One\nTwo",
|
|
||||||
"key3": "One\nTwo"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"table": {
|
|
||||||
"inline": {
|
|
||||||
"name": {
|
|
||||||
"first": "Tom",
|
|
||||||
"last": "Preston-Werner"
|
|
||||||
},
|
|
||||||
"point": {
|
|
||||||
"x": 1,
|
|
||||||
"y": 2
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"key": "value",
|
|
||||||
"subtable": {
|
|
||||||
"key": "another value"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"x": {
|
|
||||||
"y": {
|
|
||||||
"z": {
|
|
||||||
"w": {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
32
vendor/github.com/pelletier/go-toml/benchmark.sh
generated
vendored
32
vendor/github.com/pelletier/go-toml/benchmark.sh
generated
vendored
|
@ -1,32 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
reference_ref=${1:-master}
|
|
||||||
reference_git=${2:-.}
|
|
||||||
|
|
||||||
if ! `hash benchstat 2>/dev/null`; then
|
|
||||||
echo "Installing benchstat"
|
|
||||||
go get golang.org/x/perf/cmd/benchstat
|
|
||||||
go install golang.org/x/perf/cmd/benchstat
|
|
||||||
fi
|
|
||||||
|
|
||||||
tempdir=`mktemp -d /tmp/go-toml-benchmark-XXXXXX`
|
|
||||||
ref_tempdir="${tempdir}/ref"
|
|
||||||
ref_benchmark="${ref_tempdir}/benchmark-`echo -n ${reference_ref}|tr -s '/' '-'`.txt"
|
|
||||||
local_benchmark="`pwd`/benchmark-local.txt"
|
|
||||||
|
|
||||||
echo "=== ${reference_ref} (${ref_tempdir})"
|
|
||||||
git clone ${reference_git} ${ref_tempdir} >/dev/null 2>/dev/null
|
|
||||||
pushd ${ref_tempdir} >/dev/null
|
|
||||||
git checkout ${reference_ref} >/dev/null 2>/dev/null
|
|
||||||
go test -bench=. -benchmem | tee ${ref_benchmark}
|
|
||||||
popd >/dev/null
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "=== local"
|
|
||||||
go test -bench=. -benchmem | tee ${local_benchmark}
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "=== diff"
|
|
||||||
benchstat -delta-test=none ${ref_benchmark} ${local_benchmark}
|
|
244
vendor/github.com/pelletier/go-toml/benchmark.toml
generated
vendored
244
vendor/github.com/pelletier/go-toml/benchmark.toml
generated
vendored
|
@ -1,244 +0,0 @@
|
||||||
################################################################################
|
|
||||||
## Comment
|
|
||||||
|
|
||||||
# Speak your mind with the hash symbol. They go from the symbol to the end of
|
|
||||||
# the line.
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Table
|
|
||||||
|
|
||||||
# Tables (also known as hash tables or dictionaries) are collections of
|
|
||||||
# key/value pairs. They appear in square brackets on a line by themselves.
|
|
||||||
|
|
||||||
[table]
|
|
||||||
|
|
||||||
key = "value" # Yeah, you can do this.
|
|
||||||
|
|
||||||
# Nested tables are denoted by table names with dots in them. Name your tables
|
|
||||||
# whatever crap you please, just don't use #, ., [ or ].
|
|
||||||
|
|
||||||
[table.subtable]
|
|
||||||
|
|
||||||
key = "another value"
|
|
||||||
|
|
||||||
# You don't need to specify all the super-tables if you don't want to. TOML
|
|
||||||
# knows how to do it for you.
|
|
||||||
|
|
||||||
# [x] you
|
|
||||||
# [x.y] don't
|
|
||||||
# [x.y.z] need these
|
|
||||||
[x.y.z.w] # for this to work
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Inline Table
|
|
||||||
|
|
||||||
# Inline tables provide a more compact syntax for expressing tables. They are
|
|
||||||
# especially useful for grouped data that can otherwise quickly become verbose.
|
|
||||||
# Inline tables are enclosed in curly braces `{` and `}`. No newlines are
|
|
||||||
# allowed between the curly braces unless they are valid within a value.
|
|
||||||
|
|
||||||
[table.inline]
|
|
||||||
|
|
||||||
name = { first = "Tom", last = "Preston-Werner" }
|
|
||||||
point = { x = 1, y = 2 }
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## String
|
|
||||||
|
|
||||||
# There are four ways to express strings: basic, multi-line basic, literal, and
|
|
||||||
# multi-line literal. All strings must contain only valid UTF-8 characters.
|
|
||||||
|
|
||||||
[string.basic]
|
|
||||||
|
|
||||||
basic = "I'm a string. \"You can quote me\". Name\tJos\u00E9\nLocation\tSF."
|
|
||||||
|
|
||||||
[string.multiline]
|
|
||||||
|
|
||||||
# The following strings are byte-for-byte equivalent:
|
|
||||||
key1 = "One\nTwo"
|
|
||||||
key2 = """One\nTwo"""
|
|
||||||
key3 = """
|
|
||||||
One
|
|
||||||
Two"""
|
|
||||||
|
|
||||||
[string.multiline.continued]
|
|
||||||
|
|
||||||
# The following strings are byte-for-byte equivalent:
|
|
||||||
key1 = "The quick brown fox jumps over the lazy dog."
|
|
||||||
|
|
||||||
key2 = """
|
|
||||||
The quick brown \
|
|
||||||
|
|
||||||
|
|
||||||
fox jumps over \
|
|
||||||
the lazy dog."""
|
|
||||||
|
|
||||||
key3 = """\
|
|
||||||
The quick brown \
|
|
||||||
fox jumps over \
|
|
||||||
the lazy dog.\
|
|
||||||
"""
|
|
||||||
|
|
||||||
[string.literal]
|
|
||||||
|
|
||||||
# What you see is what you get.
|
|
||||||
winpath = 'C:\Users\nodejs\templates'
|
|
||||||
winpath2 = '\\ServerX\admin$\system32\'
|
|
||||||
quoted = 'Tom "Dubs" Preston-Werner'
|
|
||||||
regex = '<\i\c*\s*>'
|
|
||||||
|
|
||||||
|
|
||||||
[string.literal.multiline]
|
|
||||||
|
|
||||||
regex2 = '''I [dw]on't need \d{2} apples'''
|
|
||||||
lines = '''
|
|
||||||
The first newline is
|
|
||||||
trimmed in raw strings.
|
|
||||||
All other whitespace
|
|
||||||
is preserved.
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Integer
|
|
||||||
|
|
||||||
# Integers are whole numbers. Positive numbers may be prefixed with a plus sign.
|
|
||||||
# Negative numbers are prefixed with a minus sign.
|
|
||||||
|
|
||||||
[integer]
|
|
||||||
|
|
||||||
key1 = +99
|
|
||||||
key2 = 42
|
|
||||||
key3 = 0
|
|
||||||
key4 = -17
|
|
||||||
|
|
||||||
[integer.underscores]
|
|
||||||
|
|
||||||
# For large numbers, you may use underscores to enhance readability. Each
|
|
||||||
# underscore must be surrounded by at least one digit.
|
|
||||||
key1 = 1_000
|
|
||||||
key2 = 5_349_221
|
|
||||||
key3 = 1_2_3_4_5 # valid but inadvisable
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Float
|
|
||||||
|
|
||||||
# A float consists of an integer part (which may be prefixed with a plus or
|
|
||||||
# minus sign) followed by a fractional part and/or an exponent part.
|
|
||||||
|
|
||||||
[float.fractional]
|
|
||||||
|
|
||||||
key1 = +1.0
|
|
||||||
key2 = 3.1415
|
|
||||||
key3 = -0.01
|
|
||||||
|
|
||||||
[float.exponent]
|
|
||||||
|
|
||||||
key1 = 5e+22
|
|
||||||
key2 = 1e6
|
|
||||||
key3 = -2E-2
|
|
||||||
|
|
||||||
[float.both]
|
|
||||||
|
|
||||||
key = 6.626e-34
|
|
||||||
|
|
||||||
[float.underscores]
|
|
||||||
|
|
||||||
key1 = 9_224_617.445_991_228_313
|
|
||||||
key2 = 1e1_00
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Boolean
|
|
||||||
|
|
||||||
# Booleans are just the tokens you're used to. Always lowercase.
|
|
||||||
|
|
||||||
[boolean]
|
|
||||||
|
|
||||||
True = true
|
|
||||||
False = false
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Datetime
|
|
||||||
|
|
||||||
# Datetimes are RFC 3339 dates.
|
|
||||||
|
|
||||||
[datetime]
|
|
||||||
|
|
||||||
key1 = 1979-05-27T07:32:00Z
|
|
||||||
key2 = 1979-05-27T00:32:00-07:00
|
|
||||||
key3 = 1979-05-27T00:32:00.999999-07:00
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Array
|
|
||||||
|
|
||||||
# Arrays are square brackets with other primitives inside. Whitespace is
|
|
||||||
# ignored. Elements are separated by commas. Data types may not be mixed.
|
|
||||||
|
|
||||||
[array]
|
|
||||||
|
|
||||||
key1 = [ 1, 2, 3 ]
|
|
||||||
key2 = [ "red", "yellow", "green" ]
|
|
||||||
key3 = [ [ 1, 2 ], [3, 4, 5] ]
|
|
||||||
#key4 = [ [ 1, 2 ], ["a", "b", "c"] ] # this is ok
|
|
||||||
|
|
||||||
# Arrays can also be multiline. So in addition to ignoring whitespace, arrays
|
|
||||||
# also ignore newlines between the brackets. Terminating commas are ok before
|
|
||||||
# the closing bracket.
|
|
||||||
|
|
||||||
key5 = [
|
|
||||||
1, 2, 3
|
|
||||||
]
|
|
||||||
key6 = [
|
|
||||||
1,
|
|
||||||
2, # this is ok
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
################################################################################
|
|
||||||
## Array of Tables
|
|
||||||
|
|
||||||
# These can be expressed by using a table name in double brackets. Each table
|
|
||||||
# with the same double bracketed name will be an element in the array. The
|
|
||||||
# tables are inserted in the order encountered.
|
|
||||||
|
|
||||||
[[products]]
|
|
||||||
|
|
||||||
name = "Hammer"
|
|
||||||
sku = 738594937
|
|
||||||
|
|
||||||
[[products]]
|
|
||||||
|
|
||||||
[[products]]
|
|
||||||
|
|
||||||
name = "Nail"
|
|
||||||
sku = 284758393
|
|
||||||
color = "gray"
|
|
||||||
|
|
||||||
|
|
||||||
# You can create nested arrays of tables as well.
|
|
||||||
|
|
||||||
[[fruit]]
|
|
||||||
name = "apple"
|
|
||||||
|
|
||||||
[fruit.physical]
|
|
||||||
color = "red"
|
|
||||||
shape = "round"
|
|
||||||
|
|
||||||
[[fruit.variety]]
|
|
||||||
name = "red delicious"
|
|
||||||
|
|
||||||
[[fruit.variety]]
|
|
||||||
name = "granny smith"
|
|
||||||
|
|
||||||
[[fruit]]
|
|
||||||
name = "banana"
|
|
||||||
|
|
||||||
[[fruit.variety]]
|
|
||||||
name = "plantain"
|
|
121
vendor/github.com/pelletier/go-toml/benchmark.yml
generated
vendored
121
vendor/github.com/pelletier/go-toml/benchmark.yml
generated
vendored
|
@ -1,121 +0,0 @@
|
||||||
---
|
|
||||||
array:
|
|
||||||
key1:
|
|
||||||
- 1
|
|
||||||
- 2
|
|
||||||
- 3
|
|
||||||
key2:
|
|
||||||
- red
|
|
||||||
- yellow
|
|
||||||
- green
|
|
||||||
key3:
|
|
||||||
- - 1
|
|
||||||
- 2
|
|
||||||
- - 3
|
|
||||||
- 4
|
|
||||||
- 5
|
|
||||||
key4:
|
|
||||||
- - 1
|
|
||||||
- 2
|
|
||||||
- - a
|
|
||||||
- b
|
|
||||||
- c
|
|
||||||
key5:
|
|
||||||
- 1
|
|
||||||
- 2
|
|
||||||
- 3
|
|
||||||
key6:
|
|
||||||
- 1
|
|
||||||
- 2
|
|
||||||
boolean:
|
|
||||||
'False': false
|
|
||||||
'True': true
|
|
||||||
datetime:
|
|
||||||
key1: '1979-05-27T07:32:00Z'
|
|
||||||
key2: '1979-05-27T00:32:00-07:00'
|
|
||||||
key3: '1979-05-27T00:32:00.999999-07:00'
|
|
||||||
float:
|
|
||||||
both:
|
|
||||||
key: 6.626e-34
|
|
||||||
exponent:
|
|
||||||
key1: 5.0e+22
|
|
||||||
key2: 1000000
|
|
||||||
key3: -0.02
|
|
||||||
fractional:
|
|
||||||
key1: 1
|
|
||||||
key2: 3.1415
|
|
||||||
key3: -0.01
|
|
||||||
underscores:
|
|
||||||
key1: 9224617.445991227
|
|
||||||
key2: 1.0e+100
|
|
||||||
fruit:
|
|
||||||
- name: apple
|
|
||||||
physical:
|
|
||||||
color: red
|
|
||||||
shape: round
|
|
||||||
variety:
|
|
||||||
- name: red delicious
|
|
||||||
- name: granny smith
|
|
||||||
- name: banana
|
|
||||||
variety:
|
|
||||||
- name: plantain
|
|
||||||
integer:
|
|
||||||
key1: 99
|
|
||||||
key2: 42
|
|
||||||
key3: 0
|
|
||||||
key4: -17
|
|
||||||
underscores:
|
|
||||||
key1: 1000
|
|
||||||
key2: 5349221
|
|
||||||
key3: 12345
|
|
||||||
products:
|
|
||||||
- name: Hammer
|
|
||||||
sku: 738594937
|
|
||||||
- {}
|
|
||||||
- color: gray
|
|
||||||
name: Nail
|
|
||||||
sku: 284758393
|
|
||||||
string:
|
|
||||||
basic:
|
|
||||||
basic: "I'm a string. \"You can quote me\". Name\tJosé\nLocation\tSF."
|
|
||||||
literal:
|
|
||||||
multiline:
|
|
||||||
lines: |
|
|
||||||
The first newline is
|
|
||||||
trimmed in raw strings.
|
|
||||||
All other whitespace
|
|
||||||
is preserved.
|
|
||||||
regex2: I [dw]on't need \d{2} apples
|
|
||||||
quoted: Tom "Dubs" Preston-Werner
|
|
||||||
regex: "<\\i\\c*\\s*>"
|
|
||||||
winpath: C:\Users\nodejs\templates
|
|
||||||
winpath2: "\\\\ServerX\\admin$\\system32\\"
|
|
||||||
multiline:
|
|
||||||
continued:
|
|
||||||
key1: The quick brown fox jumps over the lazy dog.
|
|
||||||
key2: The quick brown fox jumps over the lazy dog.
|
|
||||||
key3: The quick brown fox jumps over the lazy dog.
|
|
||||||
key1: |-
|
|
||||||
One
|
|
||||||
Two
|
|
||||||
key2: |-
|
|
||||||
One
|
|
||||||
Two
|
|
||||||
key3: |-
|
|
||||||
One
|
|
||||||
Two
|
|
||||||
table:
|
|
||||||
inline:
|
|
||||||
name:
|
|
||||||
first: Tom
|
|
||||||
last: Preston-Werner
|
|
||||||
point:
|
|
||||||
x: 1
|
|
||||||
y: 2
|
|
||||||
key: value
|
|
||||||
subtable:
|
|
||||||
key: another value
|
|
||||||
x:
|
|
||||||
y:
|
|
||||||
z:
|
|
||||||
w: {}
|
|
29
vendor/github.com/pelletier/go-toml/example-crlf.toml
generated
vendored
29
vendor/github.com/pelletier/go-toml/example-crlf.toml
generated
vendored
|
@ -1,29 +0,0 @@
|
||||||
# This is a TOML document. Boom.
|
|
||||||
|
|
||||||
title = "TOML Example"
|
|
||||||
|
|
||||||
[owner]
|
|
||||||
name = "Tom Preston-Werner"
|
|
||||||
organization = "GitHub"
|
|
||||||
bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
|
|
||||||
dob = 1979-05-27T07:32:00Z # First class dates? Why not?
|
|
||||||
|
|
||||||
[database]
|
|
||||||
server = "192.168.1.1"
|
|
||||||
ports = [ 8001, 8001, 8002 ]
|
|
||||||
connection_max = 5000
|
|
||||||
enabled = true
|
|
||||||
|
|
||||||
[servers]
|
|
||||||
|
|
||||||
# You can indent as you please. Tabs or spaces. TOML don't care.
|
|
||||||
[servers.alpha]
|
|
||||||
ip = "10.0.0.1"
|
|
||||||
dc = "eqdc10"
|
|
||||||
|
|
||||||
[servers.beta]
|
|
||||||
ip = "10.0.0.2"
|
|
||||||
dc = "eqdc10"
|
|
||||||
|
|
||||||
[clients]
|
|
||||||
data = [ ["gamma", "delta"], [1, 2] ] # just an update to make sure parsers support it
|
|
29
vendor/github.com/pelletier/go-toml/example.toml
generated
vendored
29
vendor/github.com/pelletier/go-toml/example.toml
generated
vendored
|
@ -1,29 +0,0 @@
|
||||||
# This is a TOML document. Boom.
|
|
||||||
|
|
||||||
title = "TOML Example"
|
|
||||||
|
|
||||||
[owner]
|
|
||||||
name = "Tom Preston-Werner"
|
|
||||||
organization = "GitHub"
|
|
||||||
bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
|
|
||||||
dob = 1979-05-27T07:32:00Z # First class dates? Why not?
|
|
||||||
|
|
||||||
[database]
|
|
||||||
server = "192.168.1.1"
|
|
||||||
ports = [ 8001, 8001, 8002 ]
|
|
||||||
connection_max = 5000
|
|
||||||
enabled = true
|
|
||||||
|
|
||||||
[servers]
|
|
||||||
|
|
||||||
# You can indent as you please. Tabs or spaces. TOML don't care.
|
|
||||||
[servers.alpha]
|
|
||||||
ip = "10.0.0.1"
|
|
||||||
dc = "eqdc10"
|
|
||||||
|
|
||||||
[servers.beta]
|
|
||||||
ip = "10.0.0.2"
|
|
||||||
dc = "eqdc10"
|
|
||||||
|
|
||||||
[clients]
|
|
||||||
data = [ ["gamma", "delta"], [1, 2] ] # just an update to make sure parsers support it
|
|
15
vendor/github.com/pelletier/go-toml/fuzz.sh
generated
vendored
15
vendor/github.com/pelletier/go-toml/fuzz.sh
generated
vendored
|
@ -1,15 +0,0 @@
|
||||||
#! /bin/sh
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
go get github.com/dvyukov/go-fuzz/go-fuzz
|
|
||||||
go get github.com/dvyukov/go-fuzz/go-fuzz-build
|
|
||||||
|
|
||||||
if [ ! -e toml-fuzz.zip ]; then
|
|
||||||
go-fuzz-build github.com/pelletier/go-toml
|
|
||||||
fi
|
|
||||||
|
|
||||||
rm -fr fuzz
|
|
||||||
mkdir -p fuzz/corpus
|
|
||||||
cp *.toml fuzz/corpus
|
|
||||||
|
|
||||||
go-fuzz -bin=toml-fuzz.zip -workdir=fuzz
|
|
38
vendor/github.com/pelletier/go-toml/marshal_test.toml
generated
vendored
38
vendor/github.com/pelletier/go-toml/marshal_test.toml
generated
vendored
|
@ -1,38 +0,0 @@
|
||||||
title = "TOML Marshal Testing"
|
|
||||||
|
|
||||||
[basic]
|
|
||||||
bool = true
|
|
||||||
date = 1979-05-27T07:32:00Z
|
|
||||||
float = 123.4
|
|
||||||
int = 5000
|
|
||||||
string = "Bite me"
|
|
||||||
uint = 5001
|
|
||||||
|
|
||||||
[basic_lists]
|
|
||||||
bools = [true,false,true]
|
|
||||||
dates = [1979-05-27T07:32:00Z,1980-05-27T07:32:00Z]
|
|
||||||
floats = [12.3,45.6,78.9]
|
|
||||||
ints = [8001,8001,8002]
|
|
||||||
strings = ["One","Two","Three"]
|
|
||||||
uints = [5002,5003]
|
|
||||||
|
|
||||||
[basic_map]
|
|
||||||
one = "one"
|
|
||||||
two = "two"
|
|
||||||
|
|
||||||
[subdoc]
|
|
||||||
|
|
||||||
[subdoc.first]
|
|
||||||
name = "First"
|
|
||||||
|
|
||||||
[subdoc.second]
|
|
||||||
name = "Second"
|
|
||||||
|
|
||||||
[[subdoclist]]
|
|
||||||
name = "List.First"
|
|
||||||
|
|
||||||
[[subdoclist]]
|
|
||||||
name = "List.Second"
|
|
||||||
|
|
||||||
[[subdocptrs]]
|
|
||||||
name = "Second"
|
|
91
vendor/github.com/pelletier/go-toml/test.sh
generated
vendored
91
vendor/github.com/pelletier/go-toml/test.sh
generated
vendored
|
@ -1,91 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
# fail out of the script if anything here fails
|
|
||||||
set -e
|
|
||||||
set -o pipefail
|
|
||||||
|
|
||||||
# set the path to the present working directory
|
|
||||||
export GOPATH=`pwd`
|
|
||||||
|
|
||||||
function git_clone() {
|
|
||||||
path=$1
|
|
||||||
branch=$2
|
|
||||||
version=$3
|
|
||||||
if [ ! -d "src/$path" ]; then
|
|
||||||
mkdir -p src/$path
|
|
||||||
git clone https://$path.git src/$path
|
|
||||||
fi
|
|
||||||
pushd src/$path
|
|
||||||
git checkout "$branch"
|
|
||||||
git reset --hard "$version"
|
|
||||||
popd
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove potential previous runs
|
|
||||||
rm -rf src test_program_bin toml-test
|
|
||||||
|
|
||||||
# Run go vet
|
|
||||||
go vet ./...
|
|
||||||
|
|
||||||
go get github.com/pelletier/go-buffruneio
|
|
||||||
go get github.com/davecgh/go-spew/spew
|
|
||||||
go get gopkg.in/yaml.v2
|
|
||||||
go get github.com/BurntSushi/toml
|
|
||||||
|
|
||||||
# get code for BurntSushi TOML validation
|
|
||||||
# pinning all to 'HEAD' for version 0.3.x work (TODO: pin to commit hash when tests stabilize)
|
|
||||||
git_clone github.com/BurntSushi/toml master HEAD
|
|
||||||
git_clone github.com/BurntSushi/toml-test master HEAD #was: 0.2.0 HEAD
|
|
||||||
|
|
||||||
# build the BurntSushi test application
|
|
||||||
go build -o toml-test github.com/BurntSushi/toml-test
|
|
||||||
|
|
||||||
# vendorize the current lib for testing
|
|
||||||
# NOTE: this basically mocks an install without having to go back out to github for code
|
|
||||||
mkdir -p src/github.com/pelletier/go-toml/cmd
|
|
||||||
mkdir -p src/github.com/pelletier/go-toml/query
|
|
||||||
cp *.go *.toml src/github.com/pelletier/go-toml
|
|
||||||
cp -R cmd/* src/github.com/pelletier/go-toml/cmd
|
|
||||||
cp -R query/* src/github.com/pelletier/go-toml/query
|
|
||||||
go build -o test_program_bin src/github.com/pelletier/go-toml/cmd/test_program.go
|
|
||||||
|
|
||||||
# Run basic unit tests
|
|
||||||
go test github.com/pelletier/go-toml -covermode=count -coverprofile=coverage.out
|
|
||||||
go test github.com/pelletier/go-toml/cmd/tomljson
|
|
||||||
go test github.com/pelletier/go-toml/query
|
|
||||||
|
|
||||||
# run the entire BurntSushi test suite
|
|
||||||
if [[ $# -eq 0 ]] ; then
|
|
||||||
echo "Running all BurntSushi tests"
|
|
||||||
./toml-test ./test_program_bin | tee test_out
|
|
||||||
else
|
|
||||||
# run a specific test
|
|
||||||
test=$1
|
|
||||||
test_path='src/github.com/BurntSushi/toml-test/tests'
|
|
||||||
valid_test="$test_path/valid/$test"
|
|
||||||
invalid_test="$test_path/invalid/$test"
|
|
||||||
|
|
||||||
if [ -e "$valid_test.toml" ]; then
|
|
||||||
echo "Valid Test TOML for $test:"
|
|
||||||
echo "===="
|
|
||||||
cat "$valid_test.toml"
|
|
||||||
|
|
||||||
echo "Valid Test JSON for $test:"
|
|
||||||
echo "===="
|
|
||||||
cat "$valid_test.json"
|
|
||||||
|
|
||||||
echo "Go-TOML Output for $test:"
|
|
||||||
echo "===="
|
|
||||||
cat "$valid_test.toml" | ./test_program_bin
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -e "$invalid_test.toml" ]; then
|
|
||||||
echo "Invalid Test TOML for $test:"
|
|
||||||
echo "===="
|
|
||||||
cat "$invalid_test.toml"
|
|
||||||
|
|
||||||
echo "Go-TOML Output for $test:"
|
|
||||||
echo "===="
|
|
||||||
echo "go-toml Output:"
|
|
||||||
cat "$invalid_test.toml" | ./test_program_bin
|
|
||||||
fi
|
|
||||||
fi
|
|
23
vendor/github.com/pkg/errors/LICENSE
generated
vendored
Normal file
23
vendor/github.com/pkg/errors/LICENSE
generated
vendored
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
Copyright (c) 2015, Dave Cheney <dave@cheney.net>
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
* Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
269
vendor/github.com/pkg/errors/errors.go
generated
vendored
Normal file
269
vendor/github.com/pkg/errors/errors.go
generated
vendored
Normal file
|
@ -0,0 +1,269 @@
|
||||||
|
// Package errors provides simple error handling primitives.
|
||||||
|
//
|
||||||
|
// The traditional error handling idiom in Go is roughly akin to
|
||||||
|
//
|
||||||
|
// if err != nil {
|
||||||
|
// return err
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// which applied recursively up the call stack results in error reports
|
||||||
|
// without context or debugging information. The errors package allows
|
||||||
|
// programmers to add context to the failure path in their code in a way
|
||||||
|
// that does not destroy the original value of the error.
|
||||||
|
//
|
||||||
|
// Adding context to an error
|
||||||
|
//
|
||||||
|
// The errors.Wrap function returns a new error that adds context to the
|
||||||
|
// original error by recording a stack trace at the point Wrap is called,
|
||||||
|
// and the supplied message. For example
|
||||||
|
//
|
||||||
|
// _, err := ioutil.ReadAll(r)
|
||||||
|
// if err != nil {
|
||||||
|
// return errors.Wrap(err, "read failed")
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// If additional control is required the errors.WithStack and errors.WithMessage
|
||||||
|
// functions destructure errors.Wrap into its component operations of annotating
|
||||||
|
// an error with a stack trace and an a message, respectively.
|
||||||
|
//
|
||||||
|
// Retrieving the cause of an error
|
||||||
|
//
|
||||||
|
// Using errors.Wrap constructs a stack of errors, adding context to the
|
||||||
|
// preceding error. Depending on the nature of the error it may be necessary
|
||||||
|
// to reverse the operation of errors.Wrap to retrieve the original error
|
||||||
|
// for inspection. Any error value which implements this interface
|
||||||
|
//
|
||||||
|
// type causer interface {
|
||||||
|
// Cause() error
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// can be inspected by errors.Cause. errors.Cause will recursively retrieve
|
||||||
|
// the topmost error which does not implement causer, which is assumed to be
|
||||||
|
// the original cause. For example:
|
||||||
|
//
|
||||||
|
// switch err := errors.Cause(err).(type) {
|
||||||
|
// case *MyError:
|
||||||
|
// // handle specifically
|
||||||
|
// default:
|
||||||
|
// // unknown error
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// causer interface is not exported by this package, but is considered a part
|
||||||
|
// of stable public API.
|
||||||
|
//
|
||||||
|
// Formatted printing of errors
|
||||||
|
//
|
||||||
|
// All error values returned from this package implement fmt.Formatter and can
|
||||||
|
// be formatted by the fmt package. The following verbs are supported
|
||||||
|
//
|
||||||
|
// %s print the error. If the error has a Cause it will be
|
||||||
|
// printed recursively
|
||||||
|
// %v see %s
|
||||||
|
// %+v extended format. Each Frame of the error's StackTrace will
|
||||||
|
// be printed in detail.
|
||||||
|
//
|
||||||
|
// Retrieving the stack trace of an error or wrapper
|
||||||
|
//
|
||||||
|
// New, Errorf, Wrap, and Wrapf record a stack trace at the point they are
|
||||||
|
// invoked. This information can be retrieved with the following interface.
|
||||||
|
//
|
||||||
|
// type stackTracer interface {
|
||||||
|
// StackTrace() errors.StackTrace
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Where errors.StackTrace is defined as
|
||||||
|
//
|
||||||
|
// type StackTrace []Frame
|
||||||
|
//
|
||||||
|
// The Frame type represents a call site in the stack trace. Frame supports
|
||||||
|
// the fmt.Formatter interface that can be used for printing information about
|
||||||
|
// the stack trace of this error. For example:
|
||||||
|
//
|
||||||
|
// if err, ok := err.(stackTracer); ok {
|
||||||
|
// for _, f := range err.StackTrace() {
|
||||||
|
// fmt.Printf("%+s:%d", f)
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// stackTracer interface is not exported by this package, but is considered a part
|
||||||
|
// of stable public API.
|
||||||
|
//
|
||||||
|
// See the documentation for Frame.Format for more details.
|
||||||
|
package errors
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
// New returns an error with the supplied message.
|
||||||
|
// New also records the stack trace at the point it was called.
|
||||||
|
func New(message string) error {
|
||||||
|
return &fundamental{
|
||||||
|
msg: message,
|
||||||
|
stack: callers(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Errorf formats according to a format specifier and returns the string
|
||||||
|
// as a value that satisfies error.
|
||||||
|
// Errorf also records the stack trace at the point it was called.
|
||||||
|
func Errorf(format string, args ...interface{}) error {
|
||||||
|
return &fundamental{
|
||||||
|
msg: fmt.Sprintf(format, args...),
|
||||||
|
stack: callers(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// fundamental is an error that has a message and a stack, but no caller.
|
||||||
|
type fundamental struct {
|
||||||
|
msg string
|
||||||
|
*stack
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fundamental) Error() string { return f.msg }
|
||||||
|
|
||||||
|
func (f *fundamental) Format(s fmt.State, verb rune) {
|
||||||
|
switch verb {
|
||||||
|
case 'v':
|
||||||
|
if s.Flag('+') {
|
||||||
|
io.WriteString(s, f.msg)
|
||||||
|
f.stack.Format(s, verb)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
case 's':
|
||||||
|
io.WriteString(s, f.msg)
|
||||||
|
case 'q':
|
||||||
|
fmt.Fprintf(s, "%q", f.msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithStack annotates err with a stack trace at the point WithStack was called.
|
||||||
|
// If err is nil, WithStack returns nil.
|
||||||
|
func WithStack(err error) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &withStack{
|
||||||
|
err,
|
||||||
|
callers(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type withStack struct {
|
||||||
|
error
|
||||||
|
*stack
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *withStack) Cause() error { return w.error }
|
||||||
|
|
||||||
|
func (w *withStack) Format(s fmt.State, verb rune) {
|
||||||
|
switch verb {
|
||||||
|
case 'v':
|
||||||
|
if s.Flag('+') {
|
||||||
|
fmt.Fprintf(s, "%+v", w.Cause())
|
||||||
|
w.stack.Format(s, verb)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
case 's':
|
||||||
|
io.WriteString(s, w.Error())
|
||||||
|
case 'q':
|
||||||
|
fmt.Fprintf(s, "%q", w.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrap returns an error annotating err with a stack trace
|
||||||
|
// at the point Wrap is called, and the supplied message.
|
||||||
|
// If err is nil, Wrap returns nil.
|
||||||
|
func Wrap(err error, message string) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
err = &withMessage{
|
||||||
|
cause: err,
|
||||||
|
msg: message,
|
||||||
|
}
|
||||||
|
return &withStack{
|
||||||
|
err,
|
||||||
|
callers(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapf returns an error annotating err with a stack trace
|
||||||
|
// at the point Wrapf is call, and the format specifier.
|
||||||
|
// If err is nil, Wrapf returns nil.
|
||||||
|
func Wrapf(err error, format string, args ...interface{}) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
err = &withMessage{
|
||||||
|
cause: err,
|
||||||
|
msg: fmt.Sprintf(format, args...),
|
||||||
|
}
|
||||||
|
return &withStack{
|
||||||
|
err,
|
||||||
|
callers(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithMessage annotates err with a new message.
|
||||||
|
// If err is nil, WithMessage returns nil.
|
||||||
|
func WithMessage(err error, message string) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &withMessage{
|
||||||
|
cause: err,
|
||||||
|
msg: message,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type withMessage struct {
|
||||||
|
cause error
|
||||||
|
msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *withMessage) Error() string { return w.msg + ": " + w.cause.Error() }
|
||||||
|
func (w *withMessage) Cause() error { return w.cause }
|
||||||
|
|
||||||
|
func (w *withMessage) Format(s fmt.State, verb rune) {
|
||||||
|
switch verb {
|
||||||
|
case 'v':
|
||||||
|
if s.Flag('+') {
|
||||||
|
fmt.Fprintf(s, "%+v\n", w.Cause())
|
||||||
|
io.WriteString(s, w.msg)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
case 's', 'q':
|
||||||
|
io.WriteString(s, w.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Cause returns the underlying cause of the error, if possible.
|
||||||
|
// An error value has a cause if it implements the following
|
||||||
|
// interface:
|
||||||
|
//
|
||||||
|
// type causer interface {
|
||||||
|
// Cause() error
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// If the error does not implement Cause, the original error will
|
||||||
|
// be returned. If the error is nil, nil will be returned without further
|
||||||
|
// investigation.
|
||||||
|
func Cause(err error) error {
|
||||||
|
type causer interface {
|
||||||
|
Cause() error
|
||||||
|
}
|
||||||
|
|
||||||
|
for err != nil {
|
||||||
|
cause, ok := err.(causer)
|
||||||
|
if !ok {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
err = cause.Cause()
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
178
vendor/github.com/pkg/errors/stack.go
generated
vendored
Normal file
178
vendor/github.com/pkg/errors/stack.go
generated
vendored
Normal file
|
@ -0,0 +1,178 @@
|
||||||
|
package errors
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"path"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Frame represents a program counter inside a stack frame.
|
||||||
|
type Frame uintptr
|
||||||
|
|
||||||
|
// pc returns the program counter for this frame;
|
||||||
|
// multiple frames may have the same PC value.
|
||||||
|
func (f Frame) pc() uintptr { return uintptr(f) - 1 }
|
||||||
|
|
||||||
|
// file returns the full path to the file that contains the
|
||||||
|
// function for this Frame's pc.
|
||||||
|
func (f Frame) file() string {
|
||||||
|
fn := runtime.FuncForPC(f.pc())
|
||||||
|
if fn == nil {
|
||||||
|
return "unknown"
|
||||||
|
}
|
||||||
|
file, _ := fn.FileLine(f.pc())
|
||||||
|
return file
|
||||||
|
}
|
||||||
|
|
||||||
|
// line returns the line number of source code of the
|
||||||
|
// function for this Frame's pc.
|
||||||
|
func (f Frame) line() int {
|
||||||
|
fn := runtime.FuncForPC(f.pc())
|
||||||
|
if fn == nil {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
_, line := fn.FileLine(f.pc())
|
||||||
|
return line
|
||||||
|
}
|
||||||
|
|
||||||
|
// Format formats the frame according to the fmt.Formatter interface.
|
||||||
|
//
|
||||||
|
// %s source file
|
||||||
|
// %d source line
|
||||||
|
// %n function name
|
||||||
|
// %v equivalent to %s:%d
|
||||||
|
//
|
||||||
|
// Format accepts flags that alter the printing of some verbs, as follows:
|
||||||
|
//
|
||||||
|
// %+s path of source file relative to the compile time GOPATH
|
||||||
|
// %+v equivalent to %+s:%d
|
||||||
|
func (f Frame) Format(s fmt.State, verb rune) {
|
||||||
|
switch verb {
|
||||||
|
case 's':
|
||||||
|
switch {
|
||||||
|
case s.Flag('+'):
|
||||||
|
pc := f.pc()
|
||||||
|
fn := runtime.FuncForPC(pc)
|
||||||
|
if fn == nil {
|
||||||
|
io.WriteString(s, "unknown")
|
||||||
|
} else {
|
||||||
|
file, _ := fn.FileLine(pc)
|
||||||
|
fmt.Fprintf(s, "%s\n\t%s", fn.Name(), file)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
io.WriteString(s, path.Base(f.file()))
|
||||||
|
}
|
||||||
|
case 'd':
|
||||||
|
fmt.Fprintf(s, "%d", f.line())
|
||||||
|
case 'n':
|
||||||
|
name := runtime.FuncForPC(f.pc()).Name()
|
||||||
|
io.WriteString(s, funcname(name))
|
||||||
|
case 'v':
|
||||||
|
f.Format(s, 's')
|
||||||
|
io.WriteString(s, ":")
|
||||||
|
f.Format(s, 'd')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// StackTrace is stack of Frames from innermost (newest) to outermost (oldest).
|
||||||
|
type StackTrace []Frame
|
||||||
|
|
||||||
|
func (st StackTrace) Format(s fmt.State, verb rune) {
|
||||||
|
switch verb {
|
||||||
|
case 'v':
|
||||||
|
switch {
|
||||||
|
case s.Flag('+'):
|
||||||
|
for _, f := range st {
|
||||||
|
fmt.Fprintf(s, "\n%+v", f)
|
||||||
|
}
|
||||||
|
case s.Flag('#'):
|
||||||
|
fmt.Fprintf(s, "%#v", []Frame(st))
|
||||||
|
default:
|
||||||
|
fmt.Fprintf(s, "%v", []Frame(st))
|
||||||
|
}
|
||||||
|
case 's':
|
||||||
|
fmt.Fprintf(s, "%s", []Frame(st))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// stack represents a stack of program counters.
|
||||||
|
type stack []uintptr
|
||||||
|
|
||||||
|
func (s *stack) Format(st fmt.State, verb rune) {
|
||||||
|
switch verb {
|
||||||
|
case 'v':
|
||||||
|
switch {
|
||||||
|
case st.Flag('+'):
|
||||||
|
for _, pc := range *s {
|
||||||
|
f := Frame(pc)
|
||||||
|
fmt.Fprintf(st, "\n%+v", f)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *stack) StackTrace() StackTrace {
|
||||||
|
f := make([]Frame, len(*s))
|
||||||
|
for i := 0; i < len(f); i++ {
|
||||||
|
f[i] = Frame((*s)[i])
|
||||||
|
}
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
func callers() *stack {
|
||||||
|
const depth = 32
|
||||||
|
var pcs [depth]uintptr
|
||||||
|
n := runtime.Callers(3, pcs[:])
|
||||||
|
var st stack = pcs[0:n]
|
||||||
|
return &st
|
||||||
|
}
|
||||||
|
|
||||||
|
// funcname removes the path prefix component of a function's name reported by func.Name().
|
||||||
|
func funcname(name string) string {
|
||||||
|
i := strings.LastIndex(name, "/")
|
||||||
|
name = name[i+1:]
|
||||||
|
i = strings.Index(name, ".")
|
||||||
|
return name[i+1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
func trimGOPATH(name, file string) string {
|
||||||
|
// Here we want to get the source file path relative to the compile time
|
||||||
|
// GOPATH. As of Go 1.6.x there is no direct way to know the compiled
|
||||||
|
// GOPATH at runtime, but we can infer the number of path segments in the
|
||||||
|
// GOPATH. We note that fn.Name() returns the function name qualified by
|
||||||
|
// the import path, which does not include the GOPATH. Thus we can trim
|
||||||
|
// segments from the beginning of the file path until the number of path
|
||||||
|
// separators remaining is one more than the number of path separators in
|
||||||
|
// the function name. For example, given:
|
||||||
|
//
|
||||||
|
// GOPATH /home/user
|
||||||
|
// file /home/user/src/pkg/sub/file.go
|
||||||
|
// fn.Name() pkg/sub.Type.Method
|
||||||
|
//
|
||||||
|
// We want to produce:
|
||||||
|
//
|
||||||
|
// pkg/sub/file.go
|
||||||
|
//
|
||||||
|
// From this we can easily see that fn.Name() has one less path separator
|
||||||
|
// than our desired output. We count separators from the end of the file
|
||||||
|
// path until it finds two more than in the function name and then move
|
||||||
|
// one character forward to preserve the initial path segment without a
|
||||||
|
// leading separator.
|
||||||
|
const sep = "/"
|
||||||
|
goal := strings.Count(name, sep) + 2
|
||||||
|
i := len(file)
|
||||||
|
for n := 0; n < goal; n++ {
|
||||||
|
i = strings.LastIndex(file[:i], sep)
|
||||||
|
if i == -1 {
|
||||||
|
// not enough separators found, set i so that the slice expression
|
||||||
|
// below leaves file unmodified
|
||||||
|
i = -len(sep)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// get back to 0 or trim the leading separator
|
||||||
|
file = file[i+len(sep):]
|
||||||
|
return file
|
||||||
|
}
|
5
vendor/github.com/ryanuber/go-glob/.travis.yml
generated
vendored
5
vendor/github.com/ryanuber/go-glob/.travis.yml
generated
vendored
|
@ -1,5 +0,0 @@
|
||||||
language: go
|
|
||||||
go:
|
|
||||||
- tip
|
|
||||||
script:
|
|
||||||
- go test -v ./...
|
|
29
vendor/github.com/ryanuber/go-glob/README.md
generated
vendored
29
vendor/github.com/ryanuber/go-glob/README.md
generated
vendored
|
@ -1,29 +0,0 @@
|
||||||
# String globbing in golang [![Build Status](https://travis-ci.org/ryanuber/go-glob.svg)](https://travis-ci.org/ryanuber/go-glob)
|
|
||||||
|
|
||||||
`go-glob` is a single-function library implementing basic string glob support.
|
|
||||||
|
|
||||||
Globs are an extremely user-friendly way of supporting string matching without
|
|
||||||
requiring knowledge of regular expressions or Go's particular regex engine. Most
|
|
||||||
people understand that if you put a `*` character somewhere in a string, it is
|
|
||||||
treated as a wildcard. Surprisingly, this functionality isn't found in Go's
|
|
||||||
standard library, except for `path.Match`, which is intended to be used while
|
|
||||||
comparing paths (not arbitrary strings), and contains specialized logic for this
|
|
||||||
use case. A better solution might be a POSIX basic (non-ERE) regular expression
|
|
||||||
engine for Go, which doesn't exist currently.
|
|
||||||
|
|
||||||
Example
|
|
||||||
=======
|
|
||||||
|
|
||||||
```
|
|
||||||
package main
|
|
||||||
|
|
||||||
import "github.com/ryanuber/go-glob"
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
glob.Glob("*World!", "Hello, World!") // true
|
|
||||||
glob.Glob("Hello,*", "Hello, World!") // true
|
|
||||||
glob.Glob("*ello,*", "Hello, World!") // true
|
|
||||||
glob.Glob("World!", "Hello, World!") // false
|
|
||||||
glob.Glob("/home/*", "/home/ryanuber/.bashrc") // true
|
|
||||||
}
|
|
||||||
```
|
|
126
vendor/github.com/sethgrid/pester/README.md
generated
vendored
126
vendor/github.com/sethgrid/pester/README.md
generated
vendored
|
@ -1,126 +0,0 @@
|
||||||
# pester
|
|
||||||
|
|
||||||
`pester` wraps Go's standard lib http client to provide several options to increase resiliency in your request. If you experience poor network conditions or requests could experience varied delays, you can now pester the endpoint for data.
|
|
||||||
- Send out multiple requests and get the first back (only used for GET calls)
|
|
||||||
- Retry on errors
|
|
||||||
- Backoff
|
|
||||||
|
|
||||||
### Simple Example
|
|
||||||
Use `pester` where you would use the http client calls. By default, pester will use a concurrency of 1, and retry the endpoint 3 times with the `DefaultBackoff` strategy of waiting 1 second between retries.
|
|
||||||
```go
|
|
||||||
/* swap in replacement, just switch
|
|
||||||
http.{Get|Post|PostForm|Head|Do} to
|
|
||||||
pester.{Get|Post|PostForm|Head|Do}
|
|
||||||
*/
|
|
||||||
resp, err := pester.Get("http://sethammons.com")
|
|
||||||
```
|
|
||||||
|
|
||||||
### Backoff Strategy
|
|
||||||
Provide your own backoff strategy, or use one of the provided built in strategies:
|
|
||||||
- `DefaultBackoff`: 1 second
|
|
||||||
- `LinearBackoff`: n seconds where n is the retry number
|
|
||||||
- `LinearJitterBackoff`: n seconds where n is the retry number, +/- 0-33%
|
|
||||||
- `ExponentialBackoff`: n seconds where n is 2^(retry number)
|
|
||||||
- `ExponentialJitterBackoff`: n seconds where n is 2^(retry number), +/- 0-33%
|
|
||||||
|
|
||||||
```go
|
|
||||||
client := pester.New()
|
|
||||||
client.Backoff = func(retry int) time.Duration {
|
|
||||||
// set up something dynamic or use a look up table
|
|
||||||
return time.Duration(retry) * time.Minute
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Complete example
|
|
||||||
For a complete and working example, see the sample directory.
|
|
||||||
`pester` allows you to use a constructor to control:
|
|
||||||
- backoff strategy
|
|
||||||
- retries
|
|
||||||
- concurrency
|
|
||||||
- keeping a log for debugging
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/sethgrid/pester"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
log.Println("Starting...")
|
|
||||||
|
|
||||||
{ // drop in replacement for http.Get and other client methods
|
|
||||||
resp, err := pester.Get("http://example.com")
|
|
||||||
if err != nil {
|
|
||||||
log.Println("error GETing example.com", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
log.Printf("example.com %s", resp.Status)
|
|
||||||
}
|
|
||||||
|
|
||||||
{ // control the resiliency
|
|
||||||
client := pester.New()
|
|
||||||
client.Concurrency = 3
|
|
||||||
client.MaxRetries = 5
|
|
||||||
client.Backoff = pester.ExponentialBackoff
|
|
||||||
client.KeepLog = true
|
|
||||||
|
|
||||||
resp, err := client.Get("http://example.com")
|
|
||||||
if err != nil {
|
|
||||||
log.Println("error GETing example.com", client.LogString())
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
log.Printf("example.com %s", resp.Status)
|
|
||||||
}
|
|
||||||
|
|
||||||
{ // use the pester version of http.Client.Do
|
|
||||||
req, err := http.NewRequest("POST", "http://example.com", strings.NewReader("data"))
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal("Unable to create a new http request", err)
|
|
||||||
}
|
|
||||||
resp, err := pester.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
log.Println("error POSTing example.com", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
log.Printf("example.com %s", resp.Status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example Log
|
|
||||||
`pester` also allows you to control the resiliency and can optionally log the errors.
|
|
||||||
```go
|
|
||||||
c := pester.New()
|
|
||||||
c.KeepLog = true
|
|
||||||
|
|
||||||
nonExistantURL := "http://localhost:9000/foo"
|
|
||||||
_, _ = c.Get(nonExistantURL)
|
|
||||||
|
|
||||||
fmt.Println(c.LogString())
|
|
||||||
/*
|
|
||||||
Output:
|
|
||||||
|
|
||||||
1432402837 Get [GET] http://localhost:9000/foo request-0 retry-0 error: Get http://localhost:9000/foo: dial tcp 127.0.0.1:9000: connection refused
|
|
||||||
1432402838 Get [GET] http://localhost:9000/foo request-0 retry-1 error: Get http://localhost:9000/foo: dial tcp 127.0.0.1:9000: connection refused
|
|
||||||
1432402839 Get [GET] http://localhost:9000/foo request-0 retry-2 error: Get http://localhost:9000/foo: dial tcp 127.0.0.1:9000: connection refused
|
|
||||||
*/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
You can run tests in the root directory with `$ go test`. There is a benchmark-like test available with `$ cd benchmarks; go test`.
|
|
||||||
You can see `pester` in action with `$ cd sample; go run main.go`.
|
|
||||||
|
|
||||||
For watching open file descriptors, you can run `watch "lsof -i -P | grep main"` if you started the app with `go run main.go`.
|
|
||||||
I did this for watching for FD leaks. My method was to alter `sample/main.go` to only run one case (`pester.Get with set backoff stategy, concurrency and retries increased`)
|
|
||||||
and adding a sleep after the result came back. This let me verify if FDs were getting left open when they should have closed. If you know a better way, let me know!
|
|
||||||
I was able to see that FDs are now closing when they should :)
|
|
||||||
|
|
||||||
![Are we there yet?](http://butchbellah.com/wp-content/uploads/2012/06/Are-We-There-Yet.jpg)
|
|
||||||
|
|
||||||
Are we there yet? Are we there yet? Are we there yet? Are we there yet? ...
|
|
1
vendor/github.com/sirupsen/logrus/.gitignore
generated
vendored
1
vendor/github.com/sirupsen/logrus/.gitignore
generated
vendored
|
@ -1 +0,0 @@
|
||||||
logrus
|
|
15
vendor/github.com/sirupsen/logrus/.travis.yml
generated
vendored
15
vendor/github.com/sirupsen/logrus/.travis.yml
generated
vendored
|
@ -1,15 +0,0 @@
|
||||||
language: go
|
|
||||||
go:
|
|
||||||
- 1.6.x
|
|
||||||
- 1.7.x
|
|
||||||
- 1.8.x
|
|
||||||
- tip
|
|
||||||
env:
|
|
||||||
- GOMAXPROCS=4 GORACE=halt_on_error=1
|
|
||||||
install:
|
|
||||||
- go get github.com/stretchr/testify/assert
|
|
||||||
- go get gopkg.in/gemnasium/logrus-airbrake-hook.v2
|
|
||||||
- go get golang.org/x/sys/unix
|
|
||||||
- go get golang.org/x/sys/windows
|
|
||||||
script:
|
|
||||||
- go test -race -v ./...
|
|
123
vendor/github.com/sirupsen/logrus/CHANGELOG.md
generated
vendored
123
vendor/github.com/sirupsen/logrus/CHANGELOG.md
generated
vendored
|
@ -1,123 +0,0 @@
|
||||||
# 1.0.5
|
|
||||||
|
|
||||||
* Fix hooks race (#707)
|
|
||||||
* Fix panic deadlock (#695)
|
|
||||||
|
|
||||||
# 1.0.4
|
|
||||||
|
|
||||||
* Fix race when adding hooks (#612)
|
|
||||||
* Fix terminal check in AppEngine (#635)
|
|
||||||
|
|
||||||
# 1.0.3
|
|
||||||
|
|
||||||
* Replace example files with testable examples
|
|
||||||
|
|
||||||
# 1.0.2
|
|
||||||
|
|
||||||
* bug: quote non-string values in text formatter (#583)
|
|
||||||
* Make (*Logger) SetLevel a public method
|
|
||||||
|
|
||||||
# 1.0.1
|
|
||||||
|
|
||||||
* bug: fix escaping in text formatter (#575)
|
|
||||||
|
|
||||||
# 1.0.0
|
|
||||||
|
|
||||||
* Officially changed name to lower-case
|
|
||||||
* bug: colors on Windows 10 (#541)
|
|
||||||
* bug: fix race in accessing level (#512)
|
|
||||||
|
|
||||||
# 0.11.5
|
|
||||||
|
|
||||||
* feature: add writer and writerlevel to entry (#372)
|
|
||||||
|
|
||||||
# 0.11.4
|
|
||||||
|
|
||||||
* bug: fix undefined variable on solaris (#493)
|
|
||||||
|
|
||||||
# 0.11.3
|
|
||||||
|
|
||||||
* formatter: configure quoting of empty values (#484)
|
|
||||||
* formatter: configure quoting character (default is `"`) (#484)
|
|
||||||
* bug: fix not importing io correctly in non-linux environments (#481)
|
|
||||||
|
|
||||||
# 0.11.2
|
|
||||||
|
|
||||||
* bug: fix windows terminal detection (#476)
|
|
||||||
|
|
||||||
# 0.11.1
|
|
||||||
|
|
||||||
* bug: fix tty detection with custom out (#471)
|
|
||||||
|
|
||||||
# 0.11.0
|
|
||||||
|
|
||||||
* performance: Use bufferpool to allocate (#370)
|
|
||||||
* terminal: terminal detection for app-engine (#343)
|
|
||||||
* feature: exit handler (#375)
|
|
||||||
|
|
||||||
# 0.10.0
|
|
||||||
|
|
||||||
* feature: Add a test hook (#180)
|
|
||||||
* feature: `ParseLevel` is now case-insensitive (#326)
|
|
||||||
* feature: `FieldLogger` interface that generalizes `Logger` and `Entry` (#308)
|
|
||||||
* performance: avoid re-allocations on `WithFields` (#335)
|
|
||||||
|
|
||||||
# 0.9.0
|
|
||||||
|
|
||||||
* logrus/text_formatter: don't emit empty msg
|
|
||||||
* logrus/hooks/airbrake: move out of main repository
|
|
||||||
* logrus/hooks/sentry: move out of main repository
|
|
||||||
* logrus/hooks/papertrail: move out of main repository
|
|
||||||
* logrus/hooks/bugsnag: move out of main repository
|
|
||||||
* logrus/core: run tests with `-race`
|
|
||||||
* logrus/core: detect TTY based on `stderr`
|
|
||||||
* logrus/core: support `WithError` on logger
|
|
||||||
* logrus/core: Solaris support
|
|
||||||
|
|
||||||
# 0.8.7
|
|
||||||
|
|
||||||
* logrus/core: fix possible race (#216)
|
|
||||||
* logrus/doc: small typo fixes and doc improvements
|
|
||||||
|
|
||||||
|
|
||||||
# 0.8.6
|
|
||||||
|
|
||||||
* hooks/raven: allow passing an initialized client
|
|
||||||
|
|
||||||
# 0.8.5
|
|
||||||
|
|
||||||
* logrus/core: revert #208
|
|
||||||
|
|
||||||
# 0.8.4
|
|
||||||
|
|
||||||
* formatter/text: fix data race (#218)
|
|
||||||
|
|
||||||
# 0.8.3
|
|
||||||
|
|
||||||
* logrus/core: fix entry log level (#208)
|
|
||||||
* logrus/core: improve performance of text formatter by 40%
|
|
||||||
* logrus/core: expose `LevelHooks` type
|
|
||||||
* logrus/core: add support for DragonflyBSD and NetBSD
|
|
||||||
* formatter/text: print structs more verbosely
|
|
||||||
|
|
||||||
# 0.8.2
|
|
||||||
|
|
||||||
* logrus: fix more Fatal family functions
|
|
||||||
|
|
||||||
# 0.8.1
|
|
||||||
|
|
||||||
* logrus: fix not exiting on `Fatalf` and `Fatalln`
|
|
||||||
|
|
||||||
# 0.8.0
|
|
||||||
|
|
||||||
* logrus: defaults to stderr instead of stdout
|
|
||||||
* hooks/sentry: add special field for `*http.Request`
|
|
||||||
* formatter/text: ignore Windows for colors
|
|
||||||
|
|
||||||
# 0.7.3
|
|
||||||
|
|
||||||
* formatter/\*: allow configuration of timestamp layout
|
|
||||||
|
|
||||||
# 0.7.2
|
|
||||||
|
|
||||||
* formatter/text: Add configuration option for time format (#158)
|
|
511
vendor/github.com/sirupsen/logrus/README.md
generated
vendored
511
vendor/github.com/sirupsen/logrus/README.md
generated
vendored
|
@ -1,511 +0,0 @@
|
||||||
# Logrus <img src="http://i.imgur.com/hTeVwmJ.png" width="40" height="40" alt=":walrus:" class="emoji" title=":walrus:"/> [![Build Status](https://travis-ci.org/sirupsen/logrus.svg?branch=master)](https://travis-ci.org/sirupsen/logrus) [![GoDoc](https://godoc.org/github.com/sirupsen/logrus?status.svg)](https://godoc.org/github.com/sirupsen/logrus)
|
|
||||||
|
|
||||||
Logrus is a structured logger for Go (golang), completely API compatible with
|
|
||||||
the standard library logger.
|
|
||||||
|
|
||||||
**Seeing weird case-sensitive problems?** It's in the past been possible to
|
|
||||||
import Logrus as both upper- and lower-case. Due to the Go package environment,
|
|
||||||
this caused issues in the community and we needed a standard. Some environments
|
|
||||||
experienced problems with the upper-case variant, so the lower-case was decided.
|
|
||||||
Everything using `logrus` will need to use the lower-case:
|
|
||||||
`github.com/sirupsen/logrus`. Any package that isn't, should be changed.
|
|
||||||
|
|
||||||
To fix Glide, see [these
|
|
||||||
comments](https://github.com/sirupsen/logrus/issues/553#issuecomment-306591437).
|
|
||||||
For an in-depth explanation of the casing issue, see [this
|
|
||||||
comment](https://github.com/sirupsen/logrus/issues/570#issuecomment-313933276).
|
|
||||||
|
|
||||||
**Are you interested in assisting in maintaining Logrus?** Currently I have a
|
|
||||||
lot of obligations, and I am unable to provide Logrus with the maintainership it
|
|
||||||
needs. If you'd like to help, please reach out to me at `simon at author's
|
|
||||||
username dot com`.
|
|
||||||
|
|
||||||
Nicely color-coded in development (when a TTY is attached, otherwise just
|
|
||||||
plain text):
|
|
||||||
|
|
||||||
![Colored](http://i.imgur.com/PY7qMwd.png)
|
|
||||||
|
|
||||||
With `log.SetFormatter(&log.JSONFormatter{})`, for easy parsing by logstash
|
|
||||||
or Splunk:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{"animal":"walrus","level":"info","msg":"A group of walrus emerges from the
|
|
||||||
ocean","size":10,"time":"2014-03-10 19:57:38.562264131 -0400 EDT"}
|
|
||||||
|
|
||||||
{"level":"warning","msg":"The group's number increased tremendously!",
|
|
||||||
"number":122,"omg":true,"time":"2014-03-10 19:57:38.562471297 -0400 EDT"}
|
|
||||||
|
|
||||||
{"animal":"walrus","level":"info","msg":"A giant walrus appears!",
|
|
||||||
"size":10,"time":"2014-03-10 19:57:38.562500591 -0400 EDT"}
|
|
||||||
|
|
||||||
{"animal":"walrus","level":"info","msg":"Tremendously sized cow enters the ocean.",
|
|
||||||
"size":9,"time":"2014-03-10 19:57:38.562527896 -0400 EDT"}
|
|
||||||
|
|
||||||
{"level":"fatal","msg":"The ice breaks!","number":100,"omg":true,
|
|
||||||
"time":"2014-03-10 19:57:38.562543128 -0400 EDT"}
|
|
||||||
```
|
|
||||||
|
|
||||||
With the default `log.SetFormatter(&log.TextFormatter{})` when a TTY is not
|
|
||||||
attached, the output is compatible with the
|
|
||||||
[logfmt](http://godoc.org/github.com/kr/logfmt) format:
|
|
||||||
|
|
||||||
```text
|
|
||||||
time="2015-03-26T01:27:38-04:00" level=debug msg="Started observing beach" animal=walrus number=8
|
|
||||||
time="2015-03-26T01:27:38-04:00" level=info msg="A group of walrus emerges from the ocean" animal=walrus size=10
|
|
||||||
time="2015-03-26T01:27:38-04:00" level=warning msg="The group's number increased tremendously!" number=122 omg=true
|
|
||||||
time="2015-03-26T01:27:38-04:00" level=debug msg="Temperature changes" temperature=-4
|
|
||||||
time="2015-03-26T01:27:38-04:00" level=panic msg="It's over 9000!" animal=orca size=9009
|
|
||||||
time="2015-03-26T01:27:38-04:00" level=fatal msg="The ice breaks!" err=&{0x2082280c0 map[animal:orca size:9009] 2015-03-26 01:27:38.441574009 -0400 EDT panic It's over 9000!} number=100 omg=true
|
|
||||||
exit status 1
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Case-sensitivity
|
|
||||||
|
|
||||||
The organization's name was changed to lower-case--and this will not be changed
|
|
||||||
back. If you are getting import conflicts due to case sensitivity, please use
|
|
||||||
the lower-case import: `github.com/sirupsen/logrus`.
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
The simplest way to use Logrus is simply the package-level exported logger:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
log "github.com/sirupsen/logrus"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
log.WithFields(log.Fields{
|
|
||||||
"animal": "walrus",
|
|
||||||
}).Info("A walrus appears")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that it's completely api-compatible with the stdlib logger, so you can
|
|
||||||
replace your `log` imports everywhere with `log "github.com/sirupsen/logrus"`
|
|
||||||
and you'll now have the flexibility of Logrus. You can customize it all you
|
|
||||||
want:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
log "github.com/sirupsen/logrus"
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
// Log as JSON instead of the default ASCII formatter.
|
|
||||||
log.SetFormatter(&log.JSONFormatter{})
|
|
||||||
|
|
||||||
// Output to stdout instead of the default stderr
|
|
||||||
// Can be any io.Writer, see below for File example
|
|
||||||
log.SetOutput(os.Stdout)
|
|
||||||
|
|
||||||
// Only log the warning severity or above.
|
|
||||||
log.SetLevel(log.WarnLevel)
|
|
||||||
}
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
log.WithFields(log.Fields{
|
|
||||||
"animal": "walrus",
|
|
||||||
"size": 10,
|
|
||||||
}).Info("A group of walrus emerges from the ocean")
|
|
||||||
|
|
||||||
log.WithFields(log.Fields{
|
|
||||||
"omg": true,
|
|
||||||
"number": 122,
|
|
||||||
}).Warn("The group's number increased tremendously!")
|
|
||||||
|
|
||||||
log.WithFields(log.Fields{
|
|
||||||
"omg": true,
|
|
||||||
"number": 100,
|
|
||||||
}).Fatal("The ice breaks!")
|
|
||||||
|
|
||||||
// A common pattern is to re-use fields between logging statements by re-using
|
|
||||||
// the logrus.Entry returned from WithFields()
|
|
||||||
contextLogger := log.WithFields(log.Fields{
|
|
||||||
"common": "this is a common field",
|
|
||||||
"other": "I also should be logged always",
|
|
||||||
})
|
|
||||||
|
|
||||||
contextLogger.Info("I'll be logged with common and other field")
|
|
||||||
contextLogger.Info("Me too")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
For more advanced usage such as logging to multiple locations from the same
|
|
||||||
application, you can also create an instance of the `logrus` Logger:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"github.com/sirupsen/logrus"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Create a new instance of the logger. You can have any number of instances.
|
|
||||||
var log = logrus.New()
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
// The API for setting attributes is a little different than the package level
|
|
||||||
// exported logger. See Godoc.
|
|
||||||
log.Out = os.Stdout
|
|
||||||
|
|
||||||
// You could set this to any `io.Writer` such as a file
|
|
||||||
// file, err := os.OpenFile("logrus.log", os.O_CREATE|os.O_WRONLY, 0666)
|
|
||||||
// if err == nil {
|
|
||||||
// log.Out = file
|
|
||||||
// } else {
|
|
||||||
// log.Info("Failed to log to file, using default stderr")
|
|
||||||
// }
|
|
||||||
|
|
||||||
log.WithFields(logrus.Fields{
|
|
||||||
"animal": "walrus",
|
|
||||||
"size": 10,
|
|
||||||
}).Info("A group of walrus emerges from the ocean")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Fields
|
|
||||||
|
|
||||||
Logrus encourages careful, structured logging through logging fields instead of
|
|
||||||
long, unparseable error messages. For example, instead of: `log.Fatalf("Failed
|
|
||||||
to send event %s to topic %s with key %d")`, you should log the much more
|
|
||||||
discoverable:
|
|
||||||
|
|
||||||
```go
|
|
||||||
log.WithFields(log.Fields{
|
|
||||||
"event": event,
|
|
||||||
"topic": topic,
|
|
||||||
"key": key,
|
|
||||||
}).Fatal("Failed to send event")
|
|
||||||
```
|
|
||||||
|
|
||||||
We've found this API forces you to think about logging in a way that produces
|
|
||||||
much more useful logging messages. We've been in countless situations where just
|
|
||||||
a single added field to a log statement that was already there would've saved us
|
|
||||||
hours. The `WithFields` call is optional.
|
|
||||||
|
|
||||||
In general, with Logrus using any of the `printf`-family functions should be
|
|
||||||
seen as a hint you should add a field, however, you can still use the
|
|
||||||
`printf`-family functions with Logrus.
|
|
||||||
|
|
||||||
#### Default Fields
|
|
||||||
|
|
||||||
Often it's helpful to have fields _always_ attached to log statements in an
|
|
||||||
application or parts of one. For example, you may want to always log the
|
|
||||||
`request_id` and `user_ip` in the context of a request. Instead of writing
|
|
||||||
`log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})` on
|
|
||||||
every line, you can create a `logrus.Entry` to pass around instead:
|
|
||||||
|
|
||||||
```go
|
|
||||||
requestLogger := log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})
|
|
||||||
requestLogger.Info("something happened on that request") # will log request_id and user_ip
|
|
||||||
requestLogger.Warn("something not great happened")
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Hooks
|
|
||||||
|
|
||||||
You can add hooks for logging levels. For example to send errors to an exception
|
|
||||||
tracking service on `Error`, `Fatal` and `Panic`, info to StatsD or log to
|
|
||||||
multiple places simultaneously, e.g. syslog.
|
|
||||||
|
|
||||||
Logrus comes with [built-in hooks](hooks/). Add those, or your custom hook, in
|
|
||||||
`init`:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
log "github.com/sirupsen/logrus"
|
|
||||||
"gopkg.in/gemnasium/logrus-airbrake-hook.v2" // the package is named "airbrake"
|
|
||||||
logrus_syslog "github.com/sirupsen/logrus/hooks/syslog"
|
|
||||||
"log/syslog"
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
|
|
||||||
// Use the Airbrake hook to report errors that have Error severity or above to
|
|
||||||
// an exception tracker. You can create custom hooks, see the Hooks section.
|
|
||||||
log.AddHook(airbrake.NewHook(123, "xyz", "production"))
|
|
||||||
|
|
||||||
hook, err := logrus_syslog.NewSyslogHook("udp", "localhost:514", syslog.LOG_INFO, "")
|
|
||||||
if err != nil {
|
|
||||||
log.Error("Unable to connect to local syslog daemon")
|
|
||||||
} else {
|
|
||||||
log.AddHook(hook)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Note: Syslog hook also support connecting to local syslog (Ex. "/dev/log" or "/var/run/syslog" or "/var/run/log"). For the detail, please check the [syslog hook README](hooks/syslog/README.md).
|
|
||||||
|
|
||||||
| Hook | Description |
|
|
||||||
| ----- | ----------- |
|
|
||||||
| [Airbrake "legacy"](https://github.com/gemnasium/logrus-airbrake-legacy-hook) | Send errors to an exception tracking service compatible with the Airbrake API V2. Uses [`airbrake-go`](https://github.com/tobi/airbrake-go) behind the scenes. |
|
|
||||||
| [Airbrake](https://github.com/gemnasium/logrus-airbrake-hook) | Send errors to the Airbrake API V3. Uses the official [`gobrake`](https://github.com/airbrake/gobrake) behind the scenes. |
|
|
||||||
| [Amazon Kinesis](https://github.com/evalphobia/logrus_kinesis) | Hook for logging to [Amazon Kinesis](https://aws.amazon.com/kinesis/) |
|
|
||||||
| [Amqp-Hook](https://github.com/vladoatanasov/logrus_amqp) | Hook for logging to Amqp broker (Like RabbitMQ) |
|
|
||||||
| [Application Insights](https://github.com/jjcollinge/logrus-appinsights) | Hook for logging to [Application Insights](https://azure.microsoft.com/en-us/services/application-insights/)
|
|
||||||
| [AzureTableHook](https://github.com/kpfaulkner/azuretablehook/) | Hook for logging to Azure Table Storage|
|
|
||||||
| [Bugsnag](https://github.com/Shopify/logrus-bugsnag/blob/master/bugsnag.go) | Send errors to the Bugsnag exception tracking service. |
|
|
||||||
| [DeferPanic](https://github.com/deferpanic/dp-logrus) | Hook for logging to DeferPanic |
|
|
||||||
| [Discordrus](https://github.com/kz/discordrus) | Hook for logging to [Discord](https://discordapp.com/) |
|
|
||||||
| [ElasticSearch](https://github.com/sohlich/elogrus) | Hook for logging to ElasticSearch|
|
|
||||||
| [Firehose](https://github.com/beaubrewer/logrus_firehose) | Hook for logging to [Amazon Firehose](https://aws.amazon.com/kinesis/firehose/)
|
|
||||||
| [Fluentd](https://github.com/evalphobia/logrus_fluent) | Hook for logging to fluentd |
|
|
||||||
| [Go-Slack](https://github.com/multiplay/go-slack) | Hook for logging to [Slack](https://slack.com) |
|
|
||||||
| [Graylog](https://github.com/gemnasium/logrus-graylog-hook) | Hook for logging to [Graylog](http://graylog2.org/) |
|
|
||||||
| [Hiprus](https://github.com/nubo/hiprus) | Send errors to a channel in hipchat. |
|
|
||||||
| [Honeybadger](https://github.com/agonzalezro/logrus_honeybadger) | Hook for sending exceptions to Honeybadger |
|
|
||||||
| [InfluxDB](https://github.com/Abramovic/logrus_influxdb) | Hook for logging to influxdb |
|
|
||||||
| [Influxus](http://github.com/vlad-doru/influxus) | Hook for concurrently logging to [InfluxDB](http://influxdata.com/) |
|
|
||||||
| [Journalhook](https://github.com/wercker/journalhook) | Hook for logging to `systemd-journald` |
|
|
||||||
| [KafkaLogrus](https://github.com/tracer0tong/kafkalogrus) | Hook for logging to Kafka |
|
|
||||||
| [Kafka REST Proxy](https://github.com/Nordstrom/logrus-kafka-rest-proxy) | Hook for logging to [Kafka REST Proxy](https://docs.confluent.io/current/kafka-rest/docs) |
|
|
||||||
| [LFShook](https://github.com/rifflock/lfshook) | Hook for logging to the local filesystem |
|
|
||||||
| [Logbeat](https://github.com/macandmia/logbeat) | Hook for logging to [Opbeat](https://opbeat.com/) |
|
|
||||||
| [Logentries](https://github.com/jcftang/logentriesrus) | Hook for logging to [Logentries](https://logentries.com/) |
|
|
||||||
| [Logentrus](https://github.com/puddingfactory/logentrus) | Hook for logging to [Logentries](https://logentries.com/) |
|
|
||||||
| [Logmatic.io](https://github.com/logmatic/logmatic-go) | Hook for logging to [Logmatic.io](http://logmatic.io/) |
|
|
||||||
| [Logrusly](https://github.com/sebest/logrusly) | Send logs to [Loggly](https://www.loggly.com/) |
|
|
||||||
| [Logstash](https://github.com/bshuster-repo/logrus-logstash-hook) | Hook for logging to [Logstash](https://www.elastic.co/products/logstash) |
|
|
||||||
| [Mail](https://github.com/zbindenren/logrus_mail) | Hook for sending exceptions via mail |
|
|
||||||
| [Mattermost](https://github.com/shuLhan/mattermost-integration/tree/master/hooks/logrus) | Hook for logging to [Mattermost](https://mattermost.com/) |
|
|
||||||
| [Mongodb](https://github.com/weekface/mgorus) | Hook for logging to mongodb |
|
|
||||||
| [NATS-Hook](https://github.com/rybit/nats_logrus_hook) | Hook for logging to [NATS](https://nats.io) |
|
|
||||||
| [Octokit](https://github.com/dorajistyle/logrus-octokit-hook) | Hook for logging to github via octokit |
|
|
||||||
| [Papertrail](https://github.com/polds/logrus-papertrail-hook) | Send errors to the [Papertrail](https://papertrailapp.com) hosted logging service via UDP. |
|
|
||||||
| [PostgreSQL](https://github.com/gemnasium/logrus-postgresql-hook) | Send logs to [PostgreSQL](http://postgresql.org) |
|
|
||||||
| [Promrus](https://github.com/weaveworks/promrus) | Expose number of log messages as [Prometheus](https://prometheus.io/) metrics |
|
|
||||||
| [Pushover](https://github.com/toorop/logrus_pushover) | Send error via [Pushover](https://pushover.net) |
|
|
||||||
| [Raygun](https://github.com/squirkle/logrus-raygun-hook) | Hook for logging to [Raygun.io](http://raygun.io/) |
|
|
||||||
| [Redis-Hook](https://github.com/rogierlommers/logrus-redis-hook) | Hook for logging to a ELK stack (through Redis) |
|
|
||||||
| [Rollrus](https://github.com/heroku/rollrus) | Hook for sending errors to rollbar |
|
|
||||||
| [Scribe](https://github.com/sagar8192/logrus-scribe-hook) | Hook for logging to [Scribe](https://github.com/facebookarchive/scribe)|
|
|
||||||
| [Sentry](https://github.com/evalphobia/logrus_sentry) | Send errors to the Sentry error logging and aggregation service. |
|
|
||||||
| [Slackrus](https://github.com/johntdyer/slackrus) | Hook for Slack chat. |
|
|
||||||
| [Stackdriver](https://github.com/knq/sdhook) | Hook for logging to [Google Stackdriver](https://cloud.google.com/logging/) |
|
|
||||||
| [Sumorus](https://github.com/doublefree/sumorus) | Hook for logging to [SumoLogic](https://www.sumologic.com/)|
|
|
||||||
| [Syslog](https://github.com/sirupsen/logrus/blob/master/hooks/syslog/syslog.go) | Send errors to remote syslog server. Uses standard library `log/syslog` behind the scenes. |
|
|
||||||
| [Syslog TLS](https://github.com/shinji62/logrus-syslog-ng) | Send errors to remote syslog server with TLS support. |
|
|
||||||
| [Telegram](https://github.com/rossmcdonald/telegram_hook) | Hook for logging errors to [Telegram](https://telegram.org/) |
|
|
||||||
| [TraceView](https://github.com/evalphobia/logrus_appneta) | Hook for logging to [AppNeta TraceView](https://www.appneta.com/products/traceview/) |
|
|
||||||
| [Typetalk](https://github.com/dragon3/logrus-typetalk-hook) | Hook for logging to [Typetalk](https://www.typetalk.in/) |
|
|
||||||
| [logz.io](https://github.com/ripcurld00d/logrus-logzio-hook) | Hook for logging to [logz.io](https://logz.io), a Log as a Service using Logstash |
|
|
||||||
| [SQS-Hook](https://github.com/tsarpaul/logrus_sqs) | Hook for logging to [Amazon Simple Queue Service (SQS)](https://aws.amazon.com/sqs/) |
|
|
||||||
|
|
||||||
#### Level logging
|
|
||||||
|
|
||||||
Logrus has six logging levels: Debug, Info, Warning, Error, Fatal and Panic.
|
|
||||||
|
|
||||||
```go
|
|
||||||
log.Debug("Useful debugging information.")
|
|
||||||
log.Info("Something noteworthy happened!")
|
|
||||||
log.Warn("You should probably take a look at this.")
|
|
||||||
log.Error("Something failed but I'm not quitting.")
|
|
||||||
// Calls os.Exit(1) after logging
|
|
||||||
log.Fatal("Bye.")
|
|
||||||
// Calls panic() after logging
|
|
||||||
log.Panic("I'm bailing.")
|
|
||||||
```
|
|
||||||
|
|
||||||
You can set the logging level on a `Logger`, then it will only log entries with
|
|
||||||
that severity or anything above it:
|
|
||||||
|
|
||||||
```go
|
|
||||||
// Will log anything that is info or above (warn, error, fatal, panic). Default.
|
|
||||||
log.SetLevel(log.InfoLevel)
|
|
||||||
```
|
|
||||||
|
|
||||||
It may be useful to set `log.Level = logrus.DebugLevel` in a debug or verbose
|
|
||||||
environment if your application has that.
|
|
||||||
|
|
||||||
#### Entries
|
|
||||||
|
|
||||||
Besides the fields added with `WithField` or `WithFields` some fields are
|
|
||||||
automatically added to all logging events:
|
|
||||||
|
|
||||||
1. `time`. The timestamp when the entry was created.
|
|
||||||
2. `msg`. The logging message passed to `{Info,Warn,Error,Fatal,Panic}` after
|
|
||||||
the `AddFields` call. E.g. `Failed to send event.`
|
|
||||||
3. `level`. The logging level. E.g. `info`.
|
|
||||||
|
|
||||||
#### Environments
|
|
||||||
|
|
||||||
Logrus has no notion of environment.
|
|
||||||
|
|
||||||
If you wish for hooks and formatters to only be used in specific environments,
|
|
||||||
you should handle that yourself. For example, if your application has a global
|
|
||||||
variable `Environment`, which is a string representation of the environment you
|
|
||||||
could do:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
log "github.com/sirupsen/logrus"
|
|
||||||
)
|
|
||||||
|
|
||||||
init() {
|
|
||||||
// do something here to set environment depending on an environment variable
|
|
||||||
// or command-line flag
|
|
||||||
if Environment == "production" {
|
|
||||||
log.SetFormatter(&log.JSONFormatter{})
|
|
||||||
} else {
|
|
||||||
// The TextFormatter is default, you don't actually have to do this.
|
|
||||||
log.SetFormatter(&log.TextFormatter{})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This configuration is how `logrus` was intended to be used, but JSON in
|
|
||||||
production is mostly only useful if you do log aggregation with tools like
|
|
||||||
Splunk or Logstash.
|
|
||||||
|
|
||||||
#### Formatters
|
|
||||||
|
|
||||||
The built-in logging formatters are:
|
|
||||||
|
|
||||||
* `logrus.TextFormatter`. Logs the event in colors if stdout is a tty, otherwise
|
|
||||||
without colors.
|
|
||||||
* *Note:* to force colored output when there is no TTY, set the `ForceColors`
|
|
||||||
field to `true`. To force no colored output even if there is a TTY set the
|
|
||||||
`DisableColors` field to `true`. For Windows, see
|
|
||||||
[github.com/mattn/go-colorable](https://github.com/mattn/go-colorable).
|
|
||||||
* All options are listed in the [generated docs](https://godoc.org/github.com/sirupsen/logrus#TextFormatter).
|
|
||||||
* `logrus.JSONFormatter`. Logs fields as JSON.
|
|
||||||
* All options are listed in the [generated docs](https://godoc.org/github.com/sirupsen/logrus#JSONFormatter).
|
|
||||||
|
|
||||||
Third party logging formatters:
|
|
||||||
|
|
||||||
* [`FluentdFormatter`](https://github.com/joonix/log). Formats entries that can be parsed by Kubernetes and Google Container Engine.
|
|
||||||
* [`logstash`](https://github.com/bshuster-repo/logrus-logstash-hook). Logs fields as [Logstash](http://logstash.net) Events.
|
|
||||||
* [`prefixed`](https://github.com/x-cray/logrus-prefixed-formatter). Displays log entry source along with alternative layout.
|
|
||||||
* [`zalgo`](https://github.com/aybabtme/logzalgo). Invoking the P͉̫o̳̼̊w̖͈̰͎e̬͔̭͂r͚̼̹̲ ̫͓͉̳͈ō̠͕͖̚f̝͍̠ ͕̲̞͖͑Z̖̫̤̫ͪa͉̬͈̗l͖͎g̳̥o̰̥̅!̣͔̲̻͊̄ ̙̘̦̹̦.
|
|
||||||
|
|
||||||
You can define your formatter by implementing the `Formatter` interface,
|
|
||||||
requiring a `Format` method. `Format` takes an `*Entry`. `entry.Data` is a
|
|
||||||
`Fields` type (`map[string]interface{}`) with all your fields as well as the
|
|
||||||
default ones (see Entries section above):
|
|
||||||
|
|
||||||
```go
|
|
||||||
type MyJSONFormatter struct {
|
|
||||||
}
|
|
||||||
|
|
||||||
log.SetFormatter(new(MyJSONFormatter))
|
|
||||||
|
|
||||||
func (f *MyJSONFormatter) Format(entry *Entry) ([]byte, error) {
|
|
||||||
// Note this doesn't include Time, Level and Message which are available on
|
|
||||||
// the Entry. Consult `godoc` on information about those fields or read the
|
|
||||||
// source of the official loggers.
|
|
||||||
serialized, err := json.Marshal(entry.Data)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("Failed to marshal fields to JSON, %v", err)
|
|
||||||
}
|
|
||||||
return append(serialized, '\n'), nil
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Logger as an `io.Writer`
|
|
||||||
|
|
||||||
Logrus can be transformed into an `io.Writer`. That writer is the end of an `io.Pipe` and it is your responsibility to close it.
|
|
||||||
|
|
||||||
```go
|
|
||||||
w := logger.Writer()
|
|
||||||
defer w.Close()
|
|
||||||
|
|
||||||
srv := http.Server{
|
|
||||||
// create a stdlib log.Logger that writes to
|
|
||||||
// logrus.Logger.
|
|
||||||
ErrorLog: log.New(w, "", 0),
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Each line written to that writer will be printed the usual way, using formatters
|
|
||||||
and hooks. The level for those entries is `info`.
|
|
||||||
|
|
||||||
This means that we can override the standard library logger easily:
|
|
||||||
|
|
||||||
```go
|
|
||||||
logger := logrus.New()
|
|
||||||
logger.Formatter = &logrus.JSONFormatter{}
|
|
||||||
|
|
||||||
// Use logrus for standard log output
|
|
||||||
// Note that `log` here references stdlib's log
|
|
||||||
// Not logrus imported under the name `log`.
|
|
||||||
log.SetOutput(logger.Writer())
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Rotation
|
|
||||||
|
|
||||||
Log rotation is not provided with Logrus. Log rotation should be done by an
|
|
||||||
external program (like `logrotate(8)`) that can compress and delete old log
|
|
||||||
entries. It should not be a feature of the application-level logger.
|
|
||||||
|
|
||||||
#### Tools
|
|
||||||
|
|
||||||
| Tool | Description |
|
|
||||||
| ---- | ----------- |
|
|
||||||
|[Logrus Mate](https://github.com/gogap/logrus_mate)|Logrus mate is a tool for Logrus to manage loggers, you can initial logger's level, hook and formatter by config file, the logger will generated with different config at different environment.|
|
|
||||||
|[Logrus Viper Helper](https://github.com/heirko/go-contrib/tree/master/logrusHelper)|An Helper around Logrus to wrap with spf13/Viper to load configuration with fangs! And to simplify Logrus configuration use some behavior of [Logrus Mate](https://github.com/gogap/logrus_mate). [sample](https://github.com/heirko/iris-contrib/blob/master/middleware/logrus-logger/example) |
|
|
||||||
|
|
||||||
#### Testing
|
|
||||||
|
|
||||||
Logrus has a built in facility for asserting the presence of log messages. This is implemented through the `test` hook and provides:
|
|
||||||
|
|
||||||
* decorators for existing logger (`test.NewLocal` and `test.NewGlobal`) which basically just add the `test` hook
|
|
||||||
* a test logger (`test.NewNullLogger`) that just records log messages (and does not output any):
|
|
||||||
|
|
||||||
```go
|
|
||||||
import(
|
|
||||||
"github.com/sirupsen/logrus"
|
|
||||||
"github.com/sirupsen/logrus/hooks/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestSomething(t*testing.T){
|
|
||||||
logger, hook := test.NewNullLogger()
|
|
||||||
logger.Error("Helloerror")
|
|
||||||
|
|
||||||
assert.Equal(t, 1, len(hook.Entries))
|
|
||||||
assert.Equal(t, logrus.ErrorLevel, hook.LastEntry().Level)
|
|
||||||
assert.Equal(t, "Helloerror", hook.LastEntry().Message)
|
|
||||||
|
|
||||||
hook.Reset()
|
|
||||||
assert.Nil(t, hook.LastEntry())
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Fatal handlers
|
|
||||||
|
|
||||||
Logrus can register one or more functions that will be called when any `fatal`
|
|
||||||
level message is logged. The registered handlers will be executed before
|
|
||||||
logrus performs a `os.Exit(1)`. This behavior may be helpful if callers need
|
|
||||||
to gracefully shutdown. Unlike a `panic("Something went wrong...")` call which can be intercepted with a deferred `recover` a call to `os.Exit(1)` can not be intercepted.
|
|
||||||
|
|
||||||
```
|
|
||||||
...
|
|
||||||
handler := func() {
|
|
||||||
// gracefully shutdown something...
|
|
||||||
}
|
|
||||||
logrus.RegisterExitHandler(handler)
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Thread safety
|
|
||||||
|
|
||||||
By default Logger is protected by mutex for concurrent writes, this mutex is invoked when calling hooks and writing logs.
|
|
||||||
If you are sure such locking is not needed, you can call logger.SetNoLock() to disable the locking.
|
|
||||||
|
|
||||||
Situation when locking is not needed includes:
|
|
||||||
|
|
||||||
* You have no hooks registered, or hooks calling is already thread-safe.
|
|
||||||
|
|
||||||
* Writing to logger.Out is already thread-safe, for example:
|
|
||||||
|
|
||||||
1) logger.Out is protected by locks.
|
|
||||||
|
|
||||||
2) logger.Out is a os.File handler opened with `O_APPEND` flag, and every write is smaller than 4k. (This allow multi-thread/multi-process writing)
|
|
||||||
|
|
||||||
(Refer to http://www.notthewizard.com/2014/06/17/are-files-appends-really-atomic/)
|
|
14
vendor/github.com/sirupsen/logrus/appveyor.yml
generated
vendored
14
vendor/github.com/sirupsen/logrus/appveyor.yml
generated
vendored
|
@ -1,14 +0,0 @@
|
||||||
version: "{build}"
|
|
||||||
platform: x64
|
|
||||||
clone_folder: c:\gopath\src\github.com\sirupsen\logrus
|
|
||||||
environment:
|
|
||||||
GOPATH: c:\gopath
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
install:
|
|
||||||
- set PATH=%GOPATH%\bin;c:\go\bin;%PATH%
|
|
||||||
- go version
|
|
||||||
build_script:
|
|
||||||
- go get -t
|
|
||||||
- go test
|
|
21
vendor/github.com/spf13/afero/.travis.yml
generated
vendored
21
vendor/github.com/spf13/afero/.travis.yml
generated
vendored
|
@ -1,21 +0,0 @@
|
||||||
sudo: false
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.9
|
|
||||||
- "1.10"
|
|
||||||
- tip
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
fast_finish: true
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go build
|
|
||||||
- go test -race -v ./...
|
|
||||||
|
|
452
vendor/github.com/spf13/afero/README.md
generated
vendored
452
vendor/github.com/spf13/afero/README.md
generated
vendored
|
@ -1,452 +0,0 @@
|
||||||
![afero logo-sm](https://cloud.githubusercontent.com/assets/173412/11490338/d50e16dc-97a5-11e5-8b12-019a300d0fcb.png)
|
|
||||||
|
|
||||||
A FileSystem Abstraction System for Go
|
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/spf13/afero.svg)](https://travis-ci.org/spf13/afero) [![Build status](https://ci.appveyor.com/api/projects/status/github/spf13/afero?branch=master&svg=true)](https://ci.appveyor.com/project/spf13/afero) [![GoDoc](https://godoc.org/github.com/spf13/afero?status.svg)](https://godoc.org/github.com/spf13/afero) [![Join the chat at https://gitter.im/spf13/afero](https://badges.gitter.im/Dev%20Chat.svg)](https://gitter.im/spf13/afero?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
||||||
|
|
||||||
# Overview
|
|
||||||
|
|
||||||
Afero is an filesystem framework providing a simple, uniform and universal API
|
|
||||||
interacting with any filesystem, as an abstraction layer providing interfaces,
|
|
||||||
types and methods. Afero has an exceptionally clean interface and simple design
|
|
||||||
without needless constructors or initialization methods.
|
|
||||||
|
|
||||||
Afero is also a library providing a base set of interoperable backend
|
|
||||||
filesystems that make it easy to work with afero while retaining all the power
|
|
||||||
and benefit of the os and ioutil packages.
|
|
||||||
|
|
||||||
Afero provides significant improvements over using the os package alone, most
|
|
||||||
notably the ability to create mock and testing filesystems without relying on the disk.
|
|
||||||
|
|
||||||
It is suitable for use in a any situation where you would consider using the OS
|
|
||||||
package as it provides an additional abstraction that makes it easy to use a
|
|
||||||
memory backed file system during testing. It also adds support for the http
|
|
||||||
filesystem for full interoperability.
|
|
||||||
|
|
||||||
|
|
||||||
## Afero Features
|
|
||||||
|
|
||||||
* A single consistent API for accessing a variety of filesystems
|
|
||||||
* Interoperation between a variety of file system types
|
|
||||||
* A set of interfaces to encourage and enforce interoperability between backends
|
|
||||||
* An atomic cross platform memory backed file system
|
|
||||||
* Support for compositional (union) file systems by combining multiple file systems acting as one
|
|
||||||
* Specialized backends which modify existing filesystems (Read Only, Regexp filtered)
|
|
||||||
* A set of utility functions ported from io, ioutil & hugo to be afero aware
|
|
||||||
|
|
||||||
|
|
||||||
# Using Afero
|
|
||||||
|
|
||||||
Afero is easy to use and easier to adopt.
|
|
||||||
|
|
||||||
A few different ways you could use Afero:
|
|
||||||
|
|
||||||
* Use the interfaces alone to define you own file system.
|
|
||||||
* Wrap for the OS packages.
|
|
||||||
* Define different filesystems for different parts of your application.
|
|
||||||
* Use Afero for mock filesystems while testing
|
|
||||||
|
|
||||||
## Step 1: Install Afero
|
|
||||||
|
|
||||||
First use go get to install the latest version of the library.
|
|
||||||
|
|
||||||
$ go get github.com/spf13/afero
|
|
||||||
|
|
||||||
Next include Afero in your application.
|
|
||||||
```go
|
|
||||||
import "github.com/spf13/afero"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Step 2: Declare a backend
|
|
||||||
|
|
||||||
First define a package variable and set it to a pointer to a filesystem.
|
|
||||||
```go
|
|
||||||
var AppFs = afero.NewMemMapFs()
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
var AppFs = afero.NewOsFs()
|
|
||||||
```
|
|
||||||
It is important to note that if you repeat the composite literal you
|
|
||||||
will be using a completely new and isolated filesystem. In the case of
|
|
||||||
OsFs it will still use the same underlying filesystem but will reduce
|
|
||||||
the ability to drop in other filesystems as desired.
|
|
||||||
|
|
||||||
## Step 3: Use it like you would the OS package
|
|
||||||
|
|
||||||
Throughout your application use any function and method like you normally
|
|
||||||
would.
|
|
||||||
|
|
||||||
So if my application before had:
|
|
||||||
```go
|
|
||||||
os.Open('/tmp/foo')
|
|
||||||
```
|
|
||||||
We would replace it with:
|
|
||||||
```go
|
|
||||||
AppFs.Open('/tmp/foo')
|
|
||||||
```
|
|
||||||
|
|
||||||
`AppFs` being the variable we defined above.
|
|
||||||
|
|
||||||
|
|
||||||
## List of all available functions
|
|
||||||
|
|
||||||
File System Methods Available:
|
|
||||||
```go
|
|
||||||
Chmod(name string, mode os.FileMode) : error
|
|
||||||
Chtimes(name string, atime time.Time, mtime time.Time) : error
|
|
||||||
Create(name string) : File, error
|
|
||||||
Mkdir(name string, perm os.FileMode) : error
|
|
||||||
MkdirAll(path string, perm os.FileMode) : error
|
|
||||||
Name() : string
|
|
||||||
Open(name string) : File, error
|
|
||||||
OpenFile(name string, flag int, perm os.FileMode) : File, error
|
|
||||||
Remove(name string) : error
|
|
||||||
RemoveAll(path string) : error
|
|
||||||
Rename(oldname, newname string) : error
|
|
||||||
Stat(name string) : os.FileInfo, error
|
|
||||||
```
|
|
||||||
File Interfaces and Methods Available:
|
|
||||||
```go
|
|
||||||
io.Closer
|
|
||||||
io.Reader
|
|
||||||
io.ReaderAt
|
|
||||||
io.Seeker
|
|
||||||
io.Writer
|
|
||||||
io.WriterAt
|
|
||||||
|
|
||||||
Name() : string
|
|
||||||
Readdir(count int) : []os.FileInfo, error
|
|
||||||
Readdirnames(n int) : []string, error
|
|
||||||
Stat() : os.FileInfo, error
|
|
||||||
Sync() : error
|
|
||||||
Truncate(size int64) : error
|
|
||||||
WriteString(s string) : ret int, err error
|
|
||||||
```
|
|
||||||
In some applications it may make sense to define a new package that
|
|
||||||
simply exports the file system variable for easy access from anywhere.
|
|
||||||
|
|
||||||
## Using Afero's utility functions
|
|
||||||
|
|
||||||
Afero provides a set of functions to make it easier to use the underlying file systems.
|
|
||||||
These functions have been primarily ported from io & ioutil with some developed for Hugo.
|
|
||||||
|
|
||||||
The afero utilities support all afero compatible backends.
|
|
||||||
|
|
||||||
The list of utilities includes:
|
|
||||||
|
|
||||||
```go
|
|
||||||
DirExists(path string) (bool, error)
|
|
||||||
Exists(path string) (bool, error)
|
|
||||||
FileContainsBytes(filename string, subslice []byte) (bool, error)
|
|
||||||
GetTempDir(subPath string) string
|
|
||||||
IsDir(path string) (bool, error)
|
|
||||||
IsEmpty(path string) (bool, error)
|
|
||||||
ReadDir(dirname string) ([]os.FileInfo, error)
|
|
||||||
ReadFile(filename string) ([]byte, error)
|
|
||||||
SafeWriteReader(path string, r io.Reader) (err error)
|
|
||||||
TempDir(dir, prefix string) (name string, err error)
|
|
||||||
TempFile(dir, prefix string) (f File, err error)
|
|
||||||
Walk(root string, walkFn filepath.WalkFunc) error
|
|
||||||
WriteFile(filename string, data []byte, perm os.FileMode) error
|
|
||||||
WriteReader(path string, r io.Reader) (err error)
|
|
||||||
```
|
|
||||||
For a complete list see [Afero's GoDoc](https://godoc.org/github.com/spf13/afero)
|
|
||||||
|
|
||||||
They are available under two different approaches to use. You can either call
|
|
||||||
them directly where the first parameter of each function will be the file
|
|
||||||
system, or you can declare a new `Afero`, a custom type used to bind these
|
|
||||||
functions as methods to a given filesystem.
|
|
||||||
|
|
||||||
### Calling utilities directly
|
|
||||||
|
|
||||||
```go
|
|
||||||
fs := new(afero.MemMapFs)
|
|
||||||
f, err := afero.TempFile(fs,"", "ioutil-test")
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Calling via Afero
|
|
||||||
|
|
||||||
```go
|
|
||||||
fs := afero.NewMemMapFs()
|
|
||||||
afs := &afero.Afero{Fs: fs}
|
|
||||||
f, err := afs.TempFile("", "ioutil-test")
|
|
||||||
```
|
|
||||||
|
|
||||||
## Using Afero for Testing
|
|
||||||
|
|
||||||
There is a large benefit to using a mock filesystem for testing. It has a
|
|
||||||
completely blank state every time it is initialized and can be easily
|
|
||||||
reproducible regardless of OS. You could create files to your heart’s content
|
|
||||||
and the file access would be fast while also saving you from all the annoying
|
|
||||||
issues with deleting temporary files, Windows file locking, etc. The MemMapFs
|
|
||||||
backend is perfect for testing.
|
|
||||||
|
|
||||||
* Much faster than performing I/O operations on disk
|
|
||||||
* Avoid security issues and permissions
|
|
||||||
* Far more control. 'rm -rf /' with confidence
|
|
||||||
* Test setup is far more easier to do
|
|
||||||
* No test cleanup needed
|
|
||||||
|
|
||||||
One way to accomplish this is to define a variable as mentioned above.
|
|
||||||
In your application this will be set to afero.NewOsFs() during testing you
|
|
||||||
can set it to afero.NewMemMapFs().
|
|
||||||
|
|
||||||
It wouldn't be uncommon to have each test initialize a blank slate memory
|
|
||||||
backend. To do this I would define my `appFS = afero.NewOsFs()` somewhere
|
|
||||||
appropriate in my application code. This approach ensures that Tests are order
|
|
||||||
independent, with no test relying on the state left by an earlier test.
|
|
||||||
|
|
||||||
Then in my tests I would initialize a new MemMapFs for each test:
|
|
||||||
```go
|
|
||||||
func TestExist(t *testing.T) {
|
|
||||||
appFS := afero.NewMemMapFs()
|
|
||||||
// create test files and directories
|
|
||||||
appFS.MkdirAll("src/a", 0755)
|
|
||||||
afero.WriteFile(appFS, "src/a/b", []byte("file b"), 0644)
|
|
||||||
afero.WriteFile(appFS, "src/c", []byte("file c"), 0644)
|
|
||||||
name := "src/c"
|
|
||||||
_, err := appFS.Stat(name)
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
t.Errorf("file \"%s\" does not exist.\n", name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
# Available Backends
|
|
||||||
|
|
||||||
## Operating System Native
|
|
||||||
|
|
||||||
### OsFs
|
|
||||||
|
|
||||||
The first is simply a wrapper around the native OS calls. This makes it
|
|
||||||
very easy to use as all of the calls are the same as the existing OS
|
|
||||||
calls. It also makes it trivial to have your code use the OS during
|
|
||||||
operation and a mock filesystem during testing or as needed.
|
|
||||||
|
|
||||||
```go
|
|
||||||
appfs := afero.NewOsFs()
|
|
||||||
appfs.MkdirAll("src/a", 0755))
|
|
||||||
```
|
|
||||||
|
|
||||||
## Memory Backed Storage
|
|
||||||
|
|
||||||
### MemMapFs
|
|
||||||
|
|
||||||
Afero also provides a fully atomic memory backed filesystem perfect for use in
|
|
||||||
mocking and to speed up unnecessary disk io when persistence isn’t
|
|
||||||
necessary. It is fully concurrent and will work within go routines
|
|
||||||
safely.
|
|
||||||
|
|
||||||
```go
|
|
||||||
mm := afero.NewMemMapFs()
|
|
||||||
mm.MkdirAll("src/a", 0755))
|
|
||||||
```
|
|
||||||
|
|
||||||
#### InMemoryFile
|
|
||||||
|
|
||||||
As part of MemMapFs, Afero also provides an atomic, fully concurrent memory
|
|
||||||
backed file implementation. This can be used in other memory backed file
|
|
||||||
systems with ease. Plans are to add a radix tree memory stored file
|
|
||||||
system using InMemoryFile.
|
|
||||||
|
|
||||||
## Network Interfaces
|
|
||||||
|
|
||||||
### SftpFs
|
|
||||||
|
|
||||||
Afero has experimental support for secure file transfer protocol (sftp). Which can
|
|
||||||
be used to perform file operations over a encrypted channel.
|
|
||||||
|
|
||||||
## Filtering Backends
|
|
||||||
|
|
||||||
### BasePathFs
|
|
||||||
|
|
||||||
The BasePathFs restricts all operations to a given path within an Fs.
|
|
||||||
The given file name to the operations on this Fs will be prepended with
|
|
||||||
the base path before calling the source Fs.
|
|
||||||
|
|
||||||
```go
|
|
||||||
bp := afero.NewBasePathFs(afero.NewOsFs(), "/base/path")
|
|
||||||
```
|
|
||||||
|
|
||||||
### ReadOnlyFs
|
|
||||||
|
|
||||||
A thin wrapper around the source Fs providing a read only view.
|
|
||||||
|
|
||||||
```go
|
|
||||||
fs := afero.NewReadOnlyFs(afero.NewOsFs())
|
|
||||||
_, err := fs.Create("/file.txt")
|
|
||||||
// err = syscall.EPERM
|
|
||||||
```
|
|
||||||
|
|
||||||
# RegexpFs
|
|
||||||
|
|
||||||
A filtered view on file names, any file NOT matching
|
|
||||||
the passed regexp will be treated as non-existing.
|
|
||||||
Files not matching the regexp provided will not be created.
|
|
||||||
Directories are not filtered.
|
|
||||||
|
|
||||||
```go
|
|
||||||
fs := afero.NewRegexpFs(afero.NewMemMapFs(), regexp.MustCompile(`\.txt$`))
|
|
||||||
_, err := fs.Create("/file.html")
|
|
||||||
// err = syscall.ENOENT
|
|
||||||
```
|
|
||||||
|
|
||||||
### HttpFs
|
|
||||||
|
|
||||||
Afero provides an http compatible backend which can wrap any of the existing
|
|
||||||
backends.
|
|
||||||
|
|
||||||
The Http package requires a slightly specific version of Open which
|
|
||||||
returns an http.File type.
|
|
||||||
|
|
||||||
Afero provides an httpFs file system which satisfies this requirement.
|
|
||||||
Any Afero FileSystem can be used as an httpFs.
|
|
||||||
|
|
||||||
```go
|
|
||||||
httpFs := afero.NewHttpFs(<ExistingFS>)
|
|
||||||
fileserver := http.FileServer(httpFs.Dir(<PATH>)))
|
|
||||||
http.Handle("/", fileserver)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Composite Backends
|
|
||||||
|
|
||||||
Afero provides the ability have two filesystems (or more) act as a single
|
|
||||||
file system.
|
|
||||||
|
|
||||||
### CacheOnReadFs
|
|
||||||
|
|
||||||
The CacheOnReadFs will lazily make copies of any accessed files from the base
|
|
||||||
layer into the overlay. Subsequent reads will be pulled from the overlay
|
|
||||||
directly permitting the request is within the cache duration of when it was
|
|
||||||
created in the overlay.
|
|
||||||
|
|
||||||
If the base filesystem is writeable, any changes to files will be
|
|
||||||
done first to the base, then to the overlay layer. Write calls to open file
|
|
||||||
handles like `Write()` or `Truncate()` to the overlay first.
|
|
||||||
|
|
||||||
To writing files to the overlay only, you can use the overlay Fs directly (not
|
|
||||||
via the union Fs).
|
|
||||||
|
|
||||||
Cache files in the layer for the given time.Duration, a cache duration of 0
|
|
||||||
means "forever" meaning the file will not be re-requested from the base ever.
|
|
||||||
|
|
||||||
A read-only base will make the overlay also read-only but still copy files
|
|
||||||
from the base to the overlay when they're not present (or outdated) in the
|
|
||||||
caching layer.
|
|
||||||
|
|
||||||
```go
|
|
||||||
base := afero.NewOsFs()
|
|
||||||
layer := afero.NewMemMapFs()
|
|
||||||
ufs := afero.NewCacheOnReadFs(base, layer, 100 * time.Second)
|
|
||||||
```
|
|
||||||
|
|
||||||
### CopyOnWriteFs()
|
|
||||||
|
|
||||||
The CopyOnWriteFs is a read only base file system with a potentially
|
|
||||||
writeable layer on top.
|
|
||||||
|
|
||||||
Read operations will first look in the overlay and if not found there, will
|
|
||||||
serve the file from the base.
|
|
||||||
|
|
||||||
Changes to the file system will only be made in the overlay.
|
|
||||||
|
|
||||||
Any attempt to modify a file found only in the base will copy the file to the
|
|
||||||
overlay layer before modification (including opening a file with a writable
|
|
||||||
handle).
|
|
||||||
|
|
||||||
Removing and Renaming files present only in the base layer is not currently
|
|
||||||
permitted. If a file is present in the base layer and the overlay, only the
|
|
||||||
overlay will be removed/renamed.
|
|
||||||
|
|
||||||
```go
|
|
||||||
base := afero.NewOsFs()
|
|
||||||
roBase := afero.NewReadOnlyFs(base)
|
|
||||||
ufs := afero.NewCopyOnWriteFs(roBase, afero.NewMemMapFs())
|
|
||||||
|
|
||||||
fh, _ = ufs.Create("/home/test/file2.txt")
|
|
||||||
fh.WriteString("This is a test")
|
|
||||||
fh.Close()
|
|
||||||
```
|
|
||||||
|
|
||||||
In this example all write operations will only occur in memory (MemMapFs)
|
|
||||||
leaving the base filesystem (OsFs) untouched.
|
|
||||||
|
|
||||||
|
|
||||||
## Desired/possible backends
|
|
||||||
|
|
||||||
The following is a short list of possible backends we hope someone will
|
|
||||||
implement:
|
|
||||||
|
|
||||||
* SSH
|
|
||||||
* ZIP
|
|
||||||
* TAR
|
|
||||||
* S3
|
|
||||||
|
|
||||||
# About the project
|
|
||||||
|
|
||||||
## What's in the name
|
|
||||||
|
|
||||||
Afero comes from the latin roots Ad-Facere.
|
|
||||||
|
|
||||||
**"Ad"** is a prefix meaning "to".
|
|
||||||
|
|
||||||
**"Facere"** is a form of the root "faciō" making "make or do".
|
|
||||||
|
|
||||||
The literal meaning of afero is "to make" or "to do" which seems very fitting
|
|
||||||
for a library that allows one to make files and directories and do things with them.
|
|
||||||
|
|
||||||
The English word that shares the same roots as Afero is "affair". Affair shares
|
|
||||||
the same concept but as a noun it means "something that is made or done" or "an
|
|
||||||
object of a particular type".
|
|
||||||
|
|
||||||
It's also nice that unlike some of my other libraries (hugo, cobra, viper) it
|
|
||||||
Googles very well.
|
|
||||||
|
|
||||||
## Release Notes
|
|
||||||
|
|
||||||
* **0.10.0** 2015.12.10
|
|
||||||
* Full compatibility with Windows
|
|
||||||
* Introduction of afero utilities
|
|
||||||
* Test suite rewritten to work cross platform
|
|
||||||
* Normalize paths for MemMapFs
|
|
||||||
* Adding Sync to the file interface
|
|
||||||
* **Breaking Change** Walk and ReadDir have changed parameter order
|
|
||||||
* Moving types used by MemMapFs to a subpackage
|
|
||||||
* General bugfixes and improvements
|
|
||||||
* **0.9.0** 2015.11.05
|
|
||||||
* New Walk function similar to filepath.Walk
|
|
||||||
* MemMapFs.OpenFile handles O_CREATE, O_APPEND, O_TRUNC
|
|
||||||
* MemMapFs.Remove now really deletes the file
|
|
||||||
* InMemoryFile.Readdir and Readdirnames work correctly
|
|
||||||
* InMemoryFile functions lock it for concurrent access
|
|
||||||
* Test suite improvements
|
|
||||||
* **0.8.0** 2014.10.28
|
|
||||||
* First public version
|
|
||||||
* Interfaces feel ready for people to build using
|
|
||||||
* Interfaces satisfy all known uses
|
|
||||||
* MemMapFs passes the majority of the OS test suite
|
|
||||||
* OsFs passes the majority of the OS test suite
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
1. Fork it
|
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
|
||||||
5. Create new Pull Request
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
Names in no particular order:
|
|
||||||
|
|
||||||
* [spf13](https://github.com/spf13)
|
|
||||||
* [jaqx0r](https://github.com/jaqx0r)
|
|
||||||
* [mbertschler](https://github.com/mbertschler)
|
|
||||||
* [xor-gate](https://github.com/xor-gate)
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Afero is released under the Apache 2.0 license. See
|
|
||||||
[LICENSE.txt](https://github.com/spf13/afero/blob/master/LICENSE.txt)
|
|
15
vendor/github.com/spf13/afero/appveyor.yml
generated
vendored
15
vendor/github.com/spf13/afero/appveyor.yml
generated
vendored
|
@ -1,15 +0,0 @@
|
||||||
version: '{build}'
|
|
||||||
clone_folder: C:\gopath\src\github.com\spf13\afero
|
|
||||||
environment:
|
|
||||||
GOPATH: C:\gopath
|
|
||||||
build_script:
|
|
||||||
- cmd: >-
|
|
||||||
go version
|
|
||||||
|
|
||||||
go env
|
|
||||||
|
|
||||||
go get -v github.com/spf13/afero/...
|
|
||||||
|
|
||||||
go build github.com/spf13/afero
|
|
||||||
test_script:
|
|
||||||
- cmd: go test -race -v github.com/spf13/afero/...
|
|
25
vendor/github.com/spf13/cast/.gitignore
generated
vendored
25
vendor/github.com/spf13/cast/.gitignore
generated
vendored
|
@ -1,25 +0,0 @@
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
*.exe
|
|
||||||
*.test
|
|
||||||
|
|
||||||
*.bench
|
|
14
vendor/github.com/spf13/cast/.travis.yml
generated
vendored
14
vendor/github.com/spf13/cast/.travis.yml
generated
vendored
|
@ -1,14 +0,0 @@
|
||||||
language: go
|
|
||||||
sudo: required
|
|
||||||
go:
|
|
||||||
- 1.7.5
|
|
||||||
- 1.8
|
|
||||||
- tip
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
fast_finish: true
|
|
||||||
script:
|
|
||||||
- make check
|
|
38
vendor/github.com/spf13/cast/Makefile
generated
vendored
38
vendor/github.com/spf13/cast/Makefile
generated
vendored
|
@ -1,38 +0,0 @@
|
||||||
# A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
|
||||||
|
|
||||||
.PHONY: check fmt lint test test-race vet test-cover-html help
|
|
||||||
.DEFAULT_GOAL := help
|
|
||||||
|
|
||||||
check: test-race fmt vet lint ## Run tests and linters
|
|
||||||
|
|
||||||
test: ## Run tests
|
|
||||||
go test ./...
|
|
||||||
|
|
||||||
test-race: ## Run tests with race detector
|
|
||||||
go test -race ./...
|
|
||||||
|
|
||||||
fmt: ## Run gofmt linter
|
|
||||||
@for d in `go list` ; do \
|
|
||||||
if [ "`gofmt -l -s $$GOPATH/src/$$d | tee /dev/stderr`" ]; then \
|
|
||||||
echo "^ improperly formatted go files" && echo && exit 1; \
|
|
||||||
fi \
|
|
||||||
done
|
|
||||||
|
|
||||||
lint: ## Run golint linter
|
|
||||||
@for d in `go list` ; do \
|
|
||||||
if [ "`golint $$d | tee /dev/stderr`" ]; then \
|
|
||||||
echo "^ golint errors!" && echo && exit 1; \
|
|
||||||
fi \
|
|
||||||
done
|
|
||||||
|
|
||||||
vet: ## Run go vet linter
|
|
||||||
@if [ "`go vet | tee /dev/stderr`" ]; then \
|
|
||||||
echo "^ go vet errors!" && echo && exit 1; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
test-cover-html: ## Generate test coverage report
|
|
||||||
go test -coverprofile=coverage.out -covermode=count
|
|
||||||
go tool cover -func=coverage.out
|
|
||||||
|
|
||||||
help:
|
|
||||||
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
|
75
vendor/github.com/spf13/cast/README.md
generated
vendored
75
vendor/github.com/spf13/cast/README.md
generated
vendored
|
@ -1,75 +0,0 @@
|
||||||
cast
|
|
||||||
====
|
|
||||||
[![GoDoc](https://godoc.org/github.com/spf13/cast?status.svg)](https://godoc.org/github.com/spf13/cast)
|
|
||||||
[![Build Status](https://api.travis-ci.org/spf13/cast.svg?branch=master)](https://travis-ci.org/spf13/cast)
|
|
||||||
[![Go Report Card](https://goreportcard.com/badge/github.com/spf13/cast)](https://goreportcard.com/report/github.com/spf13/cast)
|
|
||||||
|
|
||||||
Easy and safe casting from one type to another in Go
|
|
||||||
|
|
||||||
Don’t Panic! ... Cast
|
|
||||||
|
|
||||||
## What is Cast?
|
|
||||||
|
|
||||||
Cast is a library to convert between different go types in a consistent and easy way.
|
|
||||||
|
|
||||||
Cast provides simple functions to easily convert a number to a string, an
|
|
||||||
interface into a bool, etc. Cast does this intelligently when an obvious
|
|
||||||
conversion is possible. It doesn’t make any attempts to guess what you meant,
|
|
||||||
for example you can only convert a string to an int when it is a string
|
|
||||||
representation of an int such as “8”. Cast was developed for use in
|
|
||||||
[Hugo](http://hugo.spf13.com), a website engine which uses YAML, TOML or JSON
|
|
||||||
for meta data.
|
|
||||||
|
|
||||||
## Why use Cast?
|
|
||||||
|
|
||||||
When working with dynamic data in Go you often need to cast or convert the data
|
|
||||||
from one type into another. Cast goes beyond just using type assertion (though
|
|
||||||
it uses that when possible) to provide a very straightforward and convenient
|
|
||||||
library.
|
|
||||||
|
|
||||||
If you are working with interfaces to handle things like dynamic content
|
|
||||||
you’ll need an easy way to convert an interface into a given type. This
|
|
||||||
is the library for you.
|
|
||||||
|
|
||||||
If you are taking in data from YAML, TOML or JSON or other formats which lack
|
|
||||||
full types, then Cast is the library for you.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Cast provides a handful of To_____ methods. These methods will always return
|
|
||||||
the desired type. **If input is provided that will not convert to that type, the
|
|
||||||
0 or nil value for that type will be returned**.
|
|
||||||
|
|
||||||
Cast also provides identical methods To_____E. These return the same result as
|
|
||||||
the To_____ methods, plus an additional error which tells you if it successfully
|
|
||||||
converted. Using these methods you can tell the difference between when the
|
|
||||||
input matched the zero value or when the conversion failed and the zero value
|
|
||||||
was returned.
|
|
||||||
|
|
||||||
The following examples are merely a sample of what is available. Please review
|
|
||||||
the code for a complete set.
|
|
||||||
|
|
||||||
### Example ‘ToString’:
|
|
||||||
|
|
||||||
cast.ToString("mayonegg") // "mayonegg"
|
|
||||||
cast.ToString(8) // "8"
|
|
||||||
cast.ToString(8.31) // "8.31"
|
|
||||||
cast.ToString([]byte("one time")) // "one time"
|
|
||||||
cast.ToString(nil) // ""
|
|
||||||
|
|
||||||
var foo interface{} = "one more time"
|
|
||||||
cast.ToString(foo) // "one more time"
|
|
||||||
|
|
||||||
|
|
||||||
### Example ‘ToInt’:
|
|
||||||
|
|
||||||
cast.ToInt(8) // 8
|
|
||||||
cast.ToInt(8.31) // 8
|
|
||||||
cast.ToInt("8") // 8
|
|
||||||
cast.ToInt(true) // 1
|
|
||||||
cast.ToInt(false) // 0
|
|
||||||
|
|
||||||
var eight interface{} = 8
|
|
||||||
cast.ToInt(eight) // 8
|
|
||||||
cast.ToInt(nil) // 0
|
|
||||||
|
|
36
vendor/github.com/spf13/cobra/.gitignore
generated
vendored
36
vendor/github.com/spf13/cobra/.gitignore
generated
vendored
|
@ -1,36 +0,0 @@
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
# Vim files https://github.com/github/gitignore/blob/master/Global/Vim.gitignore
|
|
||||||
# swap
|
|
||||||
[._]*.s[a-w][a-z]
|
|
||||||
[._]s[a-w][a-z]
|
|
||||||
# session
|
|
||||||
Session.vim
|
|
||||||
# temporary
|
|
||||||
.netrwhist
|
|
||||||
*~
|
|
||||||
# auto-generated tag files
|
|
||||||
tags
|
|
||||||
|
|
||||||
*.exe
|
|
||||||
|
|
||||||
cobra.test
|
|
3
vendor/github.com/spf13/cobra/.mailmap
generated
vendored
3
vendor/github.com/spf13/cobra/.mailmap
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
Steve Francia <steve.francia@gmail.com>
|
|
||||||
Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
|
|
||||||
Fabiano Franz <ffranz@redhat.com> <contact@fabianofranz.com>
|
|
21
vendor/github.com/spf13/cobra/.travis.yml
generated
vendored
21
vendor/github.com/spf13/cobra/.travis.yml
generated
vendored
|
@ -1,21 +0,0 @@
|
||||||
language: go
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- go: 1.9.4
|
|
||||||
- go: 1.10.0
|
|
||||||
- go: tip
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- mkdir -p bin
|
|
||||||
- curl -Lso bin/shellcheck https://github.com/caarlos0/shellcheck-docker/releases/download/v0.4.3/shellcheck
|
|
||||||
- chmod +x bin/shellcheck
|
|
||||||
script:
|
|
||||||
- PATH=$PATH:$PWD/bin go test -v ./...
|
|
||||||
- go build
|
|
||||||
- diff -u <(echo -n) <(gofmt -d -s .)
|
|
||||||
- if [ -z $NOVET ]; then
|
|
||||||
diff -u <(echo -n) <(go tool vet . 2>&1 | grep -vE 'ExampleCommand|bash_completions.*Fprint');
|
|
||||||
fi
|
|
736
vendor/github.com/spf13/cobra/README.md
generated
vendored
736
vendor/github.com/spf13/cobra/README.md
generated
vendored
|
@ -1,736 +0,0 @@
|
||||||
![cobra logo](https://cloud.githubusercontent.com/assets/173412/10886352/ad566232-814f-11e5-9cd0-aa101788c117.png)
|
|
||||||
|
|
||||||
Cobra is both a library for creating powerful modern CLI applications as well as a program to generate applications and command files.
|
|
||||||
|
|
||||||
Many of the most widely used Go projects are built using Cobra including:
|
|
||||||
|
|
||||||
* [Kubernetes](http://kubernetes.io/)
|
|
||||||
* [Hugo](http://gohugo.io)
|
|
||||||
* [rkt](https://github.com/coreos/rkt)
|
|
||||||
* [etcd](https://github.com/coreos/etcd)
|
|
||||||
* [Moby (former Docker)](https://github.com/moby/moby)
|
|
||||||
* [Docker (distribution)](https://github.com/docker/distribution)
|
|
||||||
* [OpenShift](https://www.openshift.com/)
|
|
||||||
* [Delve](https://github.com/derekparker/delve)
|
|
||||||
* [GopherJS](http://www.gopherjs.org/)
|
|
||||||
* [CockroachDB](http://www.cockroachlabs.com/)
|
|
||||||
* [Bleve](http://www.blevesearch.com/)
|
|
||||||
* [ProjectAtomic (enterprise)](http://www.projectatomic.io/)
|
|
||||||
* [GiantSwarm's swarm](https://github.com/giantswarm/cli)
|
|
||||||
* [Nanobox](https://github.com/nanobox-io/nanobox)/[Nanopack](https://github.com/nanopack)
|
|
||||||
* [rclone](http://rclone.org/)
|
|
||||||
* [nehm](https://github.com/bogem/nehm)
|
|
||||||
* [Pouch](https://github.com/alibaba/pouch)
|
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/spf13/cobra.svg "Travis CI status")](https://travis-ci.org/spf13/cobra)
|
|
||||||
[![CircleCI status](https://circleci.com/gh/spf13/cobra.png?circle-token=:circle-token "CircleCI status")](https://circleci.com/gh/spf13/cobra)
|
|
||||||
[![GoDoc](https://godoc.org/github.com/spf13/cobra?status.svg)](https://godoc.org/github.com/spf13/cobra)
|
|
||||||
|
|
||||||
# Table of Contents
|
|
||||||
|
|
||||||
- [Overview](#overview)
|
|
||||||
- [Concepts](#concepts)
|
|
||||||
* [Commands](#commands)
|
|
||||||
* [Flags](#flags)
|
|
||||||
- [Installing](#installing)
|
|
||||||
- [Getting Started](#getting-started)
|
|
||||||
* [Using the Cobra Generator](#using-the-cobra-generator)
|
|
||||||
* [Using the Cobra Library](#using-the-cobra-library)
|
|
||||||
* [Working with Flags](#working-with-flags)
|
|
||||||
* [Positional and Custom Arguments](#positional-and-custom-arguments)
|
|
||||||
* [Example](#example)
|
|
||||||
* [Help Command](#help-command)
|
|
||||||
* [Usage Message](#usage-message)
|
|
||||||
* [PreRun and PostRun Hooks](#prerun-and-postrun-hooks)
|
|
||||||
* [Suggestions when "unknown command" happens](#suggestions-when-unknown-command-happens)
|
|
||||||
* [Generating documentation for your command](#generating-documentation-for-your-command)
|
|
||||||
* [Generating bash completions](#generating-bash-completions)
|
|
||||||
- [Contributing](#contributing)
|
|
||||||
- [License](#license)
|
|
||||||
|
|
||||||
# Overview
|
|
||||||
|
|
||||||
Cobra is a library providing a simple interface to create powerful modern CLI
|
|
||||||
interfaces similar to git & go tools.
|
|
||||||
|
|
||||||
Cobra is also an application that will generate your application scaffolding to rapidly
|
|
||||||
develop a Cobra-based application.
|
|
||||||
|
|
||||||
Cobra provides:
|
|
||||||
* Easy subcommand-based CLIs: `app server`, `app fetch`, etc.
|
|
||||||
* Fully POSIX-compliant flags (including short & long versions)
|
|
||||||
* Nested subcommands
|
|
||||||
* Global, local and cascading flags
|
|
||||||
* Easy generation of applications & commands with `cobra init appname` & `cobra add cmdname`
|
|
||||||
* Intelligent suggestions (`app srver`... did you mean `app server`?)
|
|
||||||
* Automatic help generation for commands and flags
|
|
||||||
* Automatic help flag recognition of `-h`, `--help`, etc.
|
|
||||||
* Automatically generated bash autocomplete for your application
|
|
||||||
* Automatically generated man pages for your application
|
|
||||||
* Command aliases so you can change things without breaking them
|
|
||||||
* The flexibility to define your own help, usage, etc.
|
|
||||||
* Optional tight integration with [viper](http://github.com/spf13/viper) for 12-factor apps
|
|
||||||
|
|
||||||
# Concepts
|
|
||||||
|
|
||||||
Cobra is built on a structure of commands, arguments & flags.
|
|
||||||
|
|
||||||
**Commands** represent actions, **Args** are things and **Flags** are modifiers for those actions.
|
|
||||||
|
|
||||||
The best applications will read like sentences when used. Users will know how
|
|
||||||
to use the application because they will natively understand how to use it.
|
|
||||||
|
|
||||||
The pattern to follow is
|
|
||||||
`APPNAME VERB NOUN --ADJECTIVE.`
|
|
||||||
or
|
|
||||||
`APPNAME COMMAND ARG --FLAG`
|
|
||||||
|
|
||||||
A few good real world examples may better illustrate this point.
|
|
||||||
|
|
||||||
In the following example, 'server' is a command, and 'port' is a flag:
|
|
||||||
|
|
||||||
hugo server --port=1313
|
|
||||||
|
|
||||||
In this command we are telling Git to clone the url bare.
|
|
||||||
|
|
||||||
git clone URL --bare
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
Command is the central point of the application. Each interaction that
|
|
||||||
the application supports will be contained in a Command. A command can
|
|
||||||
have children commands and optionally run an action.
|
|
||||||
|
|
||||||
In the example above, 'server' is the command.
|
|
||||||
|
|
||||||
[More about cobra.Command](https://godoc.org/github.com/spf13/cobra#Command)
|
|
||||||
|
|
||||||
## Flags
|
|
||||||
|
|
||||||
A flag is a way to modify the behavior of a command. Cobra supports
|
|
||||||
fully POSIX-compliant flags as well as the Go [flag package](https://golang.org/pkg/flag/).
|
|
||||||
A Cobra command can define flags that persist through to children commands
|
|
||||||
and flags that are only available to that command.
|
|
||||||
|
|
||||||
In the example above, 'port' is the flag.
|
|
||||||
|
|
||||||
Flag functionality is provided by the [pflag
|
|
||||||
library](https://github.com/spf13/pflag), a fork of the flag standard library
|
|
||||||
which maintains the same interface while adding POSIX compliance.
|
|
||||||
|
|
||||||
# Installing
|
|
||||||
Using Cobra is easy. First, use `go get` to install the latest version
|
|
||||||
of the library. This command will install the `cobra` generator executable
|
|
||||||
along with the library and its dependencies:
|
|
||||||
|
|
||||||
go get -u github.com/spf13/cobra/cobra
|
|
||||||
|
|
||||||
Next, include Cobra in your application:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import "github.com/spf13/cobra"
|
|
||||||
```
|
|
||||||
|
|
||||||
# Getting Started
|
|
||||||
|
|
||||||
While you are welcome to provide your own organization, typically a Cobra-based
|
|
||||||
application will follow the following organizational structure:
|
|
||||||
|
|
||||||
```
|
|
||||||
▾ appName/
|
|
||||||
▾ cmd/
|
|
||||||
add.go
|
|
||||||
your.go
|
|
||||||
commands.go
|
|
||||||
here.go
|
|
||||||
main.go
|
|
||||||
```
|
|
||||||
|
|
||||||
In a Cobra app, typically the main.go file is very bare. It serves one purpose: initializing Cobra.
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"{pathToYourApp}/cmd"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
cmd.Execute()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Using the Cobra Generator
|
|
||||||
|
|
||||||
Cobra provides its own program that will create your application and add any
|
|
||||||
commands you want. It's the easiest way to incorporate Cobra into your application.
|
|
||||||
|
|
||||||
[Here](https://github.com/spf13/cobra/blob/master/cobra/README.md) you can find more information about it.
|
|
||||||
|
|
||||||
## Using the Cobra Library
|
|
||||||
|
|
||||||
To manually implement Cobra you need to create a bare main.go file and a rootCmd file.
|
|
||||||
You will optionally provide additional commands as you see fit.
|
|
||||||
|
|
||||||
### Create rootCmd
|
|
||||||
|
|
||||||
Cobra doesn't require any special constructors. Simply create your commands.
|
|
||||||
|
|
||||||
Ideally you place this in app/cmd/root.go:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var rootCmd = &cobra.Command{
|
|
||||||
Use: "hugo",
|
|
||||||
Short: "Hugo is a very fast static site generator",
|
|
||||||
Long: `A Fast and Flexible Static Site Generator built with
|
|
||||||
love by spf13 and friends in Go.
|
|
||||||
Complete documentation is available at http://hugo.spf13.com`,
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
// Do Stuff Here
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
func Execute() {
|
|
||||||
if err := rootCmd.Execute(); err != nil {
|
|
||||||
fmt.Println(err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
You will additionally define flags and handle configuration in your init() function.
|
|
||||||
|
|
||||||
For example cmd/root.go:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
homedir "github.com/mitchellh/go-homedir"
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
"github.com/spf13/viper"
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
cobra.OnInitialize(initConfig)
|
|
||||||
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cobra.yaml)")
|
|
||||||
rootCmd.PersistentFlags().StringVarP(&projectBase, "projectbase", "b", "", "base project directory eg. github.com/spf13/")
|
|
||||||
rootCmd.PersistentFlags().StringP("author", "a", "YOUR NAME", "Author name for copyright attribution")
|
|
||||||
rootCmd.PersistentFlags().StringVarP(&userLicense, "license", "l", "", "Name of license for the project (can provide `licensetext` in config)")
|
|
||||||
rootCmd.PersistentFlags().Bool("viper", true, "Use Viper for configuration")
|
|
||||||
viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
|
|
||||||
viper.BindPFlag("projectbase", rootCmd.PersistentFlags().Lookup("projectbase"))
|
|
||||||
viper.BindPFlag("useViper", rootCmd.PersistentFlags().Lookup("viper"))
|
|
||||||
viper.SetDefault("author", "NAME HERE <EMAIL ADDRESS>")
|
|
||||||
viper.SetDefault("license", "apache")
|
|
||||||
}
|
|
||||||
|
|
||||||
func initConfig() {
|
|
||||||
// Don't forget to read config either from cfgFile or from home directory!
|
|
||||||
if cfgFile != "" {
|
|
||||||
// Use config file from the flag.
|
|
||||||
viper.SetConfigFile(cfgFile)
|
|
||||||
} else {
|
|
||||||
// Find home directory.
|
|
||||||
home, err := homedir.Dir()
|
|
||||||
if err != nil {
|
|
||||||
fmt.Println(err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Search config in home directory with name ".cobra" (without extension).
|
|
||||||
viper.AddConfigPath(home)
|
|
||||||
viper.SetConfigName(".cobra")
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := viper.ReadInConfig(); err != nil {
|
|
||||||
fmt.Println("Can't read config:", err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Create your main.go
|
|
||||||
|
|
||||||
With the root command you need to have your main function execute it.
|
|
||||||
Execute should be run on the root for clarity, though it can be called on any command.
|
|
||||||
|
|
||||||
In a Cobra app, typically the main.go file is very bare. It serves, one purpose, to initialize Cobra.
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"{pathToYourApp}/cmd"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
cmd.Execute()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Create additional commands
|
|
||||||
|
|
||||||
Additional commands can be defined and typically are each given their own file
|
|
||||||
inside of the cmd/ directory.
|
|
||||||
|
|
||||||
If you wanted to create a version command you would create cmd/version.go and
|
|
||||||
populate it with the following:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
rootCmd.AddCommand(versionCmd)
|
|
||||||
}
|
|
||||||
|
|
||||||
var versionCmd = &cobra.Command{
|
|
||||||
Use: "version",
|
|
||||||
Short: "Print the version number of Hugo",
|
|
||||||
Long: `All software has versions. This is Hugo's`,
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Println("Hugo Static Site Generator v0.9 -- HEAD")
|
|
||||||
},
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Working with Flags
|
|
||||||
|
|
||||||
Flags provide modifiers to control how the action command operates.
|
|
||||||
|
|
||||||
### Assign flags to a command
|
|
||||||
|
|
||||||
Since the flags are defined and used in different locations, we need to
|
|
||||||
define a variable outside with the correct scope to assign the flag to
|
|
||||||
work with.
|
|
||||||
|
|
||||||
```go
|
|
||||||
var Verbose bool
|
|
||||||
var Source string
|
|
||||||
```
|
|
||||||
|
|
||||||
There are two different approaches to assign a flag.
|
|
||||||
|
|
||||||
### Persistent Flags
|
|
||||||
|
|
||||||
A flag can be 'persistent' meaning that this flag will be available to the
|
|
||||||
command it's assigned to as well as every command under that command. For
|
|
||||||
global flags, assign a flag as a persistent flag on the root.
|
|
||||||
|
|
||||||
```go
|
|
||||||
rootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "verbose output")
|
|
||||||
```
|
|
||||||
|
|
||||||
### Local Flags
|
|
||||||
|
|
||||||
A flag can also be assigned locally which will only apply to that specific command.
|
|
||||||
|
|
||||||
```go
|
|
||||||
rootCmd.Flags().StringVarP(&Source, "source", "s", "", "Source directory to read from")
|
|
||||||
```
|
|
||||||
|
|
||||||
### Local Flag on Parent Commands
|
|
||||||
|
|
||||||
By default Cobra only parses local flags on the target command, any local flags on
|
|
||||||
parent commands are ignored. By enabling `Command.TraverseChildren` Cobra will
|
|
||||||
parse local flags on each command before executing the target command.
|
|
||||||
|
|
||||||
```go
|
|
||||||
command := cobra.Command{
|
|
||||||
Use: "print [OPTIONS] [COMMANDS]",
|
|
||||||
TraverseChildren: true,
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Bind Flags with Config
|
|
||||||
|
|
||||||
You can also bind your flags with [viper](https://github.com/spf13/viper):
|
|
||||||
```go
|
|
||||||
var author string
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
rootCmd.PersistentFlags().StringVar(&author, "author", "YOUR NAME", "Author name for copyright attribution")
|
|
||||||
viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
In this example the persistent flag `author` is bound with `viper`.
|
|
||||||
**Note**, that the variable `author` will not be set to the value from config,
|
|
||||||
when the `--author` flag is not provided by user.
|
|
||||||
|
|
||||||
More in [viper documentation](https://github.com/spf13/viper#working-with-flags).
|
|
||||||
|
|
||||||
### Required flags
|
|
||||||
|
|
||||||
Flags are optional by default. If instead you wish your command to report an error
|
|
||||||
when a flag has not been set, mark it as required:
|
|
||||||
```go
|
|
||||||
rootCmd.Flags().StringVarP(&Region, "region", "r", "", "AWS region (required)")
|
|
||||||
rootCmd.MarkFlagRequired("region")
|
|
||||||
```
|
|
||||||
|
|
||||||
## Positional and Custom Arguments
|
|
||||||
|
|
||||||
Validation of positional arguments can be specified using the `Args` field
|
|
||||||
of `Command`.
|
|
||||||
|
|
||||||
The following validators are built in:
|
|
||||||
|
|
||||||
- `NoArgs` - the command will report an error if there are any positional args.
|
|
||||||
- `ArbitraryArgs` - the command will accept any args.
|
|
||||||
- `OnlyValidArgs` - the command will report an error if there are any positional args that are not in the `ValidArgs` field of `Command`.
|
|
||||||
- `MinimumNArgs(int)` - the command will report an error if there are not at least N positional args.
|
|
||||||
- `MaximumNArgs(int)` - the command will report an error if there are more than N positional args.
|
|
||||||
- `ExactArgs(int)` - the command will report an error if there are not exactly N positional args.
|
|
||||||
- `RangeArgs(min, max)` - the command will report an error if the number of args is not between the minimum and maximum number of expected args.
|
|
||||||
|
|
||||||
An example of setting the custom validator:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var cmd = &cobra.Command{
|
|
||||||
Short: "hello",
|
|
||||||
Args: func(cmd *cobra.Command, args []string) error {
|
|
||||||
if len(args) < 1 {
|
|
||||||
return errors.New("requires at least one arg")
|
|
||||||
}
|
|
||||||
if myapp.IsValidColor(args[0]) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return fmt.Errorf("invalid color specified: %s", args[0])
|
|
||||||
},
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Println("Hello, World!")
|
|
||||||
},
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
In the example below, we have defined three commands. Two are at the top level
|
|
||||||
and one (cmdTimes) is a child of one of the top commands. In this case the root
|
|
||||||
is not executable meaning that a subcommand is required. This is accomplished
|
|
||||||
by not providing a 'Run' for the 'rootCmd'.
|
|
||||||
|
|
||||||
We have only defined one flag for a single command.
|
|
||||||
|
|
||||||
More documentation about flags is available at https://github.com/spf13/pflag
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
var echoTimes int
|
|
||||||
|
|
||||||
var cmdPrint = &cobra.Command{
|
|
||||||
Use: "print [string to print]",
|
|
||||||
Short: "Print anything to the screen",
|
|
||||||
Long: `print is for printing anything back to the screen.
|
|
||||||
For many years people have printed back to the screen.`,
|
|
||||||
Args: cobra.MinimumNArgs(1),
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Println("Print: " + strings.Join(args, " "))
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
var cmdEcho = &cobra.Command{
|
|
||||||
Use: "echo [string to echo]",
|
|
||||||
Short: "Echo anything to the screen",
|
|
||||||
Long: `echo is for echoing anything back.
|
|
||||||
Echo works a lot like print, except it has a child command.`,
|
|
||||||
Args: cobra.MinimumNArgs(1),
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Println("Print: " + strings.Join(args, " "))
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
var cmdTimes = &cobra.Command{
|
|
||||||
Use: "times [# times] [string to echo]",
|
|
||||||
Short: "Echo anything to the screen more times",
|
|
||||||
Long: `echo things multiple times back to the user by providing
|
|
||||||
a count and a string.`,
|
|
||||||
Args: cobra.MinimumNArgs(1),
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
for i := 0; i < echoTimes; i++ {
|
|
||||||
fmt.Println("Echo: " + strings.Join(args, " "))
|
|
||||||
}
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
cmdTimes.Flags().IntVarP(&echoTimes, "times", "t", 1, "times to echo the input")
|
|
||||||
|
|
||||||
var rootCmd = &cobra.Command{Use: "app"}
|
|
||||||
rootCmd.AddCommand(cmdPrint, cmdEcho)
|
|
||||||
cmdEcho.AddCommand(cmdTimes)
|
|
||||||
rootCmd.Execute()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
For a more complete example of a larger application, please checkout [Hugo](http://gohugo.io/).
|
|
||||||
|
|
||||||
## Help Command
|
|
||||||
|
|
||||||
Cobra automatically adds a help command to your application when you have subcommands.
|
|
||||||
This will be called when a user runs 'app help'. Additionally, help will also
|
|
||||||
support all other commands as input. Say, for instance, you have a command called
|
|
||||||
'create' without any additional configuration; Cobra will work when 'app help
|
|
||||||
create' is called. Every command will automatically have the '--help' flag added.
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
The following output is automatically generated by Cobra. Nothing beyond the
|
|
||||||
command and flag definitions are needed.
|
|
||||||
|
|
||||||
$ cobra help
|
|
||||||
|
|
||||||
Cobra is a CLI library for Go that empowers applications.
|
|
||||||
This application is a tool to generate the needed files
|
|
||||||
to quickly create a Cobra application.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
cobra [command]
|
|
||||||
|
|
||||||
Available Commands:
|
|
||||||
add Add a command to a Cobra Application
|
|
||||||
help Help about any command
|
|
||||||
init Initialize a Cobra Application
|
|
||||||
|
|
||||||
Flags:
|
|
||||||
-a, --author string author name for copyright attribution (default "YOUR NAME")
|
|
||||||
--config string config file (default is $HOME/.cobra.yaml)
|
|
||||||
-h, --help help for cobra
|
|
||||||
-l, --license string name of license for the project
|
|
||||||
--viper use Viper for configuration (default true)
|
|
||||||
|
|
||||||
Use "cobra [command] --help" for more information about a command.
|
|
||||||
|
|
||||||
|
|
||||||
Help is just a command like any other. There is no special logic or behavior
|
|
||||||
around it. In fact, you can provide your own if you want.
|
|
||||||
|
|
||||||
### Defining your own help
|
|
||||||
|
|
||||||
You can provide your own Help command or your own template for the default command to use
|
|
||||||
with following functions:
|
|
||||||
|
|
||||||
```go
|
|
||||||
cmd.SetHelpCommand(cmd *Command)
|
|
||||||
cmd.SetHelpFunc(f func(*Command, []string))
|
|
||||||
cmd.SetHelpTemplate(s string)
|
|
||||||
```
|
|
||||||
|
|
||||||
The latter two will also apply to any children commands.
|
|
||||||
|
|
||||||
## Usage Message
|
|
||||||
|
|
||||||
When the user provides an invalid flag or invalid command, Cobra responds by
|
|
||||||
showing the user the 'usage'.
|
|
||||||
|
|
||||||
### Example
|
|
||||||
You may recognize this from the help above. That's because the default help
|
|
||||||
embeds the usage as part of its output.
|
|
||||||
|
|
||||||
$ cobra --invalid
|
|
||||||
Error: unknown flag: --invalid
|
|
||||||
Usage:
|
|
||||||
cobra [command]
|
|
||||||
|
|
||||||
Available Commands:
|
|
||||||
add Add a command to a Cobra Application
|
|
||||||
help Help about any command
|
|
||||||
init Initialize a Cobra Application
|
|
||||||
|
|
||||||
Flags:
|
|
||||||
-a, --author string author name for copyright attribution (default "YOUR NAME")
|
|
||||||
--config string config file (default is $HOME/.cobra.yaml)
|
|
||||||
-h, --help help for cobra
|
|
||||||
-l, --license string name of license for the project
|
|
||||||
--viper use Viper for configuration (default true)
|
|
||||||
|
|
||||||
Use "cobra [command] --help" for more information about a command.
|
|
||||||
|
|
||||||
### Defining your own usage
|
|
||||||
You can provide your own usage function or template for Cobra to use.
|
|
||||||
Like help, the function and template are overridable through public methods:
|
|
||||||
|
|
||||||
```go
|
|
||||||
cmd.SetUsageFunc(f func(*Command) error)
|
|
||||||
cmd.SetUsageTemplate(s string)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Version Flag
|
|
||||||
|
|
||||||
Cobra adds a top-level '--version' flag if the Version field is set on the root command.
|
|
||||||
Running an application with the '--version' flag will print the version to stdout using
|
|
||||||
the version template. The template can be customized using the
|
|
||||||
`cmd.SetVersionTemplate(s string)` function.
|
|
||||||
|
|
||||||
## PreRun and PostRun Hooks
|
|
||||||
|
|
||||||
It is possible to run functions before or after the main `Run` function of your command. The `PersistentPreRun` and `PreRun` functions will be executed before `Run`. `PersistentPostRun` and `PostRun` will be executed after `Run`. The `Persistent*Run` functions will be inherited by children if they do not declare their own. These functions are run in the following order:
|
|
||||||
|
|
||||||
- `PersistentPreRun`
|
|
||||||
- `PreRun`
|
|
||||||
- `Run`
|
|
||||||
- `PostRun`
|
|
||||||
- `PersistentPostRun`
|
|
||||||
|
|
||||||
An example of two commands which use all of these features is below. When the subcommand is executed, it will run the root command's `PersistentPreRun` but not the root command's `PersistentPostRun`:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
|
|
||||||
var rootCmd = &cobra.Command{
|
|
||||||
Use: "root [sub]",
|
|
||||||
Short: "My root command",
|
|
||||||
PersistentPreRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside rootCmd PersistentPreRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
PreRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside rootCmd PreRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside rootCmd Run with args: %v\n", args)
|
|
||||||
},
|
|
||||||
PostRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside rootCmd PostRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
PersistentPostRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside rootCmd PersistentPostRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
var subCmd = &cobra.Command{
|
|
||||||
Use: "sub [no options!]",
|
|
||||||
Short: "My subcommand",
|
|
||||||
PreRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside subCmd PreRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside subCmd Run with args: %v\n", args)
|
|
||||||
},
|
|
||||||
PostRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside subCmd PostRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
PersistentPostRun: func(cmd *cobra.Command, args []string) {
|
|
||||||
fmt.Printf("Inside subCmd PersistentPostRun with args: %v\n", args)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
rootCmd.AddCommand(subCmd)
|
|
||||||
|
|
||||||
rootCmd.SetArgs([]string{""})
|
|
||||||
rootCmd.Execute()
|
|
||||||
fmt.Println()
|
|
||||||
rootCmd.SetArgs([]string{"sub", "arg1", "arg2"})
|
|
||||||
rootCmd.Execute()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
```
|
|
||||||
Inside rootCmd PersistentPreRun with args: []
|
|
||||||
Inside rootCmd PreRun with args: []
|
|
||||||
Inside rootCmd Run with args: []
|
|
||||||
Inside rootCmd PostRun with args: []
|
|
||||||
Inside rootCmd PersistentPostRun with args: []
|
|
||||||
|
|
||||||
Inside rootCmd PersistentPreRun with args: [arg1 arg2]
|
|
||||||
Inside subCmd PreRun with args: [arg1 arg2]
|
|
||||||
Inside subCmd Run with args: [arg1 arg2]
|
|
||||||
Inside subCmd PostRun with args: [arg1 arg2]
|
|
||||||
Inside subCmd PersistentPostRun with args: [arg1 arg2]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Suggestions when "unknown command" happens
|
|
||||||
|
|
||||||
Cobra will print automatic suggestions when "unknown command" errors happen. This allows Cobra to behave similarly to the `git` command when a typo happens. For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ hugo srever
|
|
||||||
Error: unknown command "srever" for "hugo"
|
|
||||||
|
|
||||||
Did you mean this?
|
|
||||||
server
|
|
||||||
|
|
||||||
Run 'hugo --help' for usage.
|
|
||||||
```
|
|
||||||
|
|
||||||
Suggestions are automatic based on every subcommand registered and use an implementation of [Levenshtein distance](http://en.wikipedia.org/wiki/Levenshtein_distance). Every registered command that matches a minimum distance of 2 (ignoring case) will be displayed as a suggestion.
|
|
||||||
|
|
||||||
If you need to disable suggestions or tweak the string distance in your command, use:
|
|
||||||
|
|
||||||
```go
|
|
||||||
command.DisableSuggestions = true
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```go
|
|
||||||
command.SuggestionsMinimumDistance = 1
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also explicitly set names for which a given command will be suggested using the `SuggestFor` attribute. This allows suggestions for strings that are not close in terms of string distance, but makes sense in your set of commands and for some which you don't want aliases. Example:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ kubectl remove
|
|
||||||
Error: unknown command "remove" for "kubectl"
|
|
||||||
|
|
||||||
Did you mean this?
|
|
||||||
delete
|
|
||||||
|
|
||||||
Run 'kubectl help' for usage.
|
|
||||||
```
|
|
||||||
|
|
||||||
## Generating documentation for your command
|
|
||||||
|
|
||||||
Cobra can generate documentation based on subcommands, flags, etc. in the following formats:
|
|
||||||
|
|
||||||
- [Markdown](doc/md_docs.md)
|
|
||||||
- [ReStructured Text](doc/rest_docs.md)
|
|
||||||
- [Man Page](doc/man_docs.md)
|
|
||||||
|
|
||||||
## Generating bash completions
|
|
||||||
|
|
||||||
Cobra can generate a bash-completion file. If you add more information to your command, these completions can be amazingly powerful and flexible. Read more about it in [Bash Completions](bash_completions.md).
|
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
1. Fork it
|
|
||||||
2. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`)
|
|
||||||
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
4. Make changes and add them (`git add .`)
|
|
||||||
5. Commit your changes (`git commit -m 'Add some feature'`)
|
|
||||||
6. Push to the branch (`git push origin my-new-feature`)
|
|
||||||
7. Create new pull request
|
|
||||||
|
|
||||||
# License
|
|
||||||
|
|
||||||
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
|
|
221
vendor/github.com/spf13/cobra/bash_completions.md
generated
vendored
221
vendor/github.com/spf13/cobra/bash_completions.md
generated
vendored
|
@ -1,221 +0,0 @@
|
||||||
# Generating Bash Completions For Your Own cobra.Command
|
|
||||||
|
|
||||||
Generating bash completions from a cobra command is incredibly easy. An actual program which does so for the kubernetes kubectl binary is as follows:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io/ioutil"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"k8s.io/kubernetes/pkg/kubectl/cmd"
|
|
||||||
"k8s.io/kubernetes/pkg/kubectl/cmd/util"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
kubectl := cmd.NewKubectlCommand(util.NewFactory(nil), os.Stdin, ioutil.Discard, ioutil.Discard)
|
|
||||||
kubectl.GenBashCompletionFile("out.sh")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`out.sh` will get you completions of subcommands and flags. Copy it to `/etc/bash_completion.d/` as described [here](https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1) and reset your terminal to use autocompletion. If you make additional annotations to your code, you can get even more intelligent and flexible behavior.
|
|
||||||
|
|
||||||
## Creating your own custom functions
|
|
||||||
|
|
||||||
Some more actual code that works in kubernetes:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
const (
|
|
||||||
bash_completion_func = `__kubectl_parse_get()
|
|
||||||
{
|
|
||||||
local kubectl_output out
|
|
||||||
if kubectl_output=$(kubectl get --no-headers "$1" 2>/dev/null); then
|
|
||||||
out=($(echo "${kubectl_output}" | awk '{print $1}'))
|
|
||||||
COMPREPLY=( $( compgen -W "${out[*]}" -- "$cur" ) )
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
__kubectl_get_resource()
|
|
||||||
{
|
|
||||||
if [[ ${#nouns[@]} -eq 0 ]]; then
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
__kubectl_parse_get ${nouns[${#nouns[@]} -1]}
|
|
||||||
if [[ $? -eq 0 ]]; then
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
__custom_func() {
|
|
||||||
case ${last_command} in
|
|
||||||
kubectl_get | kubectl_describe | kubectl_delete | kubectl_stop)
|
|
||||||
__kubectl_get_resource
|
|
||||||
return
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
`)
|
|
||||||
```
|
|
||||||
|
|
||||||
And then I set that in my command definition:
|
|
||||||
|
|
||||||
```go
|
|
||||||
cmds := &cobra.Command{
|
|
||||||
Use: "kubectl",
|
|
||||||
Short: "kubectl controls the Kubernetes cluster manager",
|
|
||||||
Long: `kubectl controls the Kubernetes cluster manager.
|
|
||||||
|
|
||||||
Find more information at https://github.com/GoogleCloudPlatform/kubernetes.`,
|
|
||||||
Run: runHelp,
|
|
||||||
BashCompletionFunction: bash_completion_func,
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The `BashCompletionFunction` option is really only valid/useful on the root command. Doing the above will cause `__custom_func()` to be called when the built in processor was unable to find a solution. In the case of kubernetes a valid command might look something like `kubectl get pod [mypod]`. If you type `kubectl get pod [tab][tab]` the `__customc_func()` will run because the cobra.Command only understood "kubectl" and "get." `__custom_func()` will see that the cobra.Command is "kubectl_get" and will thus call another helper `__kubectl_get_resource()`. `__kubectl_get_resource` will look at the 'nouns' collected. In our example the only noun will be `pod`. So it will call `__kubectl_parse_get pod`. `__kubectl_parse_get` will actually call out to kubernetes and get any pods. It will then set `COMPREPLY` to valid pods!
|
|
||||||
|
|
||||||
## Have the completions code complete your 'nouns'
|
|
||||||
|
|
||||||
In the above example "pod" was assumed to already be typed. But if you want `kubectl get [tab][tab]` to show a list of valid "nouns" you have to set them. Simplified code from `kubectl get` looks like:
|
|
||||||
|
|
||||||
```go
|
|
||||||
validArgs []string = { "pod", "node", "service", "replicationcontroller" }
|
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
|
||||||
Use: "get [(-o|--output=)json|yaml|template|...] (RESOURCE [NAME] | RESOURCE/NAME ...)",
|
|
||||||
Short: "Display one or many resources",
|
|
||||||
Long: get_long,
|
|
||||||
Example: get_example,
|
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
|
||||||
err := RunGet(f, out, cmd, args)
|
|
||||||
util.CheckErr(err)
|
|
||||||
},
|
|
||||||
ValidArgs: validArgs,
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Notice we put the "ValidArgs" on the "get" subcommand. Doing so will give results like
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# kubectl get [tab][tab]
|
|
||||||
node pod replicationcontroller service
|
|
||||||
```
|
|
||||||
|
|
||||||
## Plural form and shortcuts for nouns
|
|
||||||
|
|
||||||
If your nouns have a number of aliases, you can define them alongside `ValidArgs` using `ArgAliases`:
|
|
||||||
|
|
||||||
```go
|
|
||||||
argAliases []string = { "pods", "nodes", "services", "svc", "replicationcontrollers", "rc" }
|
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
|
||||||
...
|
|
||||||
ValidArgs: validArgs,
|
|
||||||
ArgAliases: argAliases
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The aliases are not shown to the user on tab completion, but they are accepted as valid nouns by
|
|
||||||
the completion algorithm if entered manually, e.g. in:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# kubectl get rc [tab][tab]
|
|
||||||
backend frontend database
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that without declaring `rc` as an alias, the completion algorithm would show the list of nouns
|
|
||||||
in this example again instead of the replication controllers.
|
|
||||||
|
|
||||||
## Mark flags as required
|
|
||||||
|
|
||||||
Most of the time completions will only show subcommands. But if a flag is required to make a subcommand work, you probably want it to show up when the user types [tab][tab]. Marking a flag as 'Required' is incredibly easy.
|
|
||||||
|
|
||||||
```go
|
|
||||||
cmd.MarkFlagRequired("pod")
|
|
||||||
cmd.MarkFlagRequired("container")
|
|
||||||
```
|
|
||||||
|
|
||||||
and you'll get something like
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# kubectl exec [tab][tab][tab]
|
|
||||||
-c --container= -p --pod=
|
|
||||||
```
|
|
||||||
|
|
||||||
# Specify valid filename extensions for flags that take a filename
|
|
||||||
|
|
||||||
In this example we use --filename= and expect to get a json or yaml file as the argument. To make this easier we annotate the --filename flag with valid filename extensions.
|
|
||||||
|
|
||||||
```go
|
|
||||||
annotations := []string{"json", "yaml", "yml"}
|
|
||||||
annotation := make(map[string][]string)
|
|
||||||
annotation[cobra.BashCompFilenameExt] = annotations
|
|
||||||
|
|
||||||
flag := &pflag.Flag{
|
|
||||||
Name: "filename",
|
|
||||||
Shorthand: "f",
|
|
||||||
Usage: usage,
|
|
||||||
Value: value,
|
|
||||||
DefValue: value.String(),
|
|
||||||
Annotations: annotation,
|
|
||||||
}
|
|
||||||
cmd.Flags().AddFlag(flag)
|
|
||||||
```
|
|
||||||
|
|
||||||
Now when you run a command with this filename flag you'll get something like
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# kubectl create -f
|
|
||||||
test/ example/ rpmbuild/
|
|
||||||
hello.yml test.json
|
|
||||||
```
|
|
||||||
|
|
||||||
So while there are many other files in the CWD it only shows me subdirs and those with valid extensions.
|
|
||||||
|
|
||||||
# Specify custom flag completion
|
|
||||||
|
|
||||||
Similar to the filename completion and filtering using cobra.BashCompFilenameExt, you can specify
|
|
||||||
a custom flag completion function with cobra.BashCompCustom:
|
|
||||||
|
|
||||||
```go
|
|
||||||
annotation := make(map[string][]string)
|
|
||||||
annotation[cobra.BashCompCustom] = []string{"__kubectl_get_namespaces"}
|
|
||||||
|
|
||||||
flag := &pflag.Flag{
|
|
||||||
Name: "namespace",
|
|
||||||
Usage: usage,
|
|
||||||
Annotations: annotation,
|
|
||||||
}
|
|
||||||
cmd.Flags().AddFlag(flag)
|
|
||||||
```
|
|
||||||
|
|
||||||
In addition add the `__handle_namespace_flag` implementation in the `BashCompletionFunction`
|
|
||||||
value, e.g.:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
__kubectl_get_namespaces()
|
|
||||||
{
|
|
||||||
local template
|
|
||||||
template="{{ range .items }}{{ .metadata.name }} {{ end }}"
|
|
||||||
local kubectl_out
|
|
||||||
if kubectl_out=$(kubectl get -o template --template="${template}" namespace 2>/dev/null); then
|
|
||||||
COMPREPLY=( $( compgen -W "${kubectl_out}[*]" -- "$cur" ) )
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
```
|
|
||||||
# Using bash aliases for commands
|
|
||||||
|
|
||||||
You can also configure the `bash aliases` for the commands and they will also support completions.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
alias aliasname=origcommand
|
|
||||||
complete -o default -F __start_origcommand aliasname
|
|
||||||
|
|
||||||
# and now when you run `aliasname` completion will make
|
|
||||||
# suggestions as it did for `origcommand`.
|
|
||||||
|
|
||||||
$) aliasname <tab><tab>
|
|
||||||
completion firstcommand secondcommand
|
|
||||||
```
|
|
683
vendor/github.com/spf13/cobra/cobra/cmd/license_agpl.go
generated
vendored
683
vendor/github.com/spf13/cobra/cobra/cmd/license_agpl.go
generated
vendored
|
@ -1,683 +0,0 @@
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initAgpl() {
|
|
||||||
Licenses["agpl"] = License{
|
|
||||||
Name: "GNU Affero General Public License",
|
|
||||||
PossibleMatches: []string{"agpl", "affero gpl", "gnu agpl"},
|
|
||||||
Header: `
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU Affero General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU Affero General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.`,
|
|
||||||
Text: ` GNU AFFERO GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 19 November 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU Affero General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works, specifically designed to ensure
|
|
||||||
cooperation with the community in the case of network server software.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
|
||||||
you this License which gives you legal permission to copy, distribute
|
|
||||||
and/or modify the software.
|
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
|
||||||
improvements made in alternate versions of the program, if they
|
|
||||||
receive widespread use, become available for other developers to
|
|
||||||
incorporate. Many developers of free software are heartened and
|
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
|
||||||
software used on network servers, this result may fail to come about.
|
|
||||||
The GNU General Public License permits making a modified version and
|
|
||||||
letting the public access it on a server without ever releasing its
|
|
||||||
source code to the public.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
|
||||||
ensure that, in such cases, the modified source code becomes available
|
|
||||||
to the community. It requires the operator of a network server to
|
|
||||||
provide the source code of the modified version running there to the
|
|
||||||
users of that server. Therefore, public use of a modified version, on
|
|
||||||
a publicly accessible server, gives the public access to the source
|
|
||||||
code of the modified version.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
|
||||||
this license.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the
|
|
||||||
Program, your modified version must prominently offer all users
|
|
||||||
interacting with it remotely through a computer network (if your version
|
|
||||||
supports such interaction) an opportunity to receive the Corresponding
|
|
||||||
Source of your version by providing access to the Corresponding Source
|
|
||||||
from a network server at no charge, through some standard or customary
|
|
||||||
means of facilitating copying of software. This Corresponding Source
|
|
||||||
shall include the Corresponding Source for any work covered by version 3
|
|
||||||
of the GNU General Public License that is incorporated pursuant to the
|
|
||||||
following paragraph.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the work with which it is combined will remain governed by version
|
|
||||||
3 of the GNU General Public License.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU Affero General Public License from time to time. Such new versions
|
|
||||||
will be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU Affero General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU Affero General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU Affero General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU Affero General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU Affero General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If your software can interact with users remotely through a computer
|
|
||||||
network, you should also make sure that it provides a way for users to
|
|
||||||
get its source. For example, if your program is a web application, its
|
|
||||||
interface could display a "Source" link that leads users to an archive
|
|
||||||
of the code. There are many ways you could offer source, and different
|
|
||||||
solutions will be better for different programs; see section 13 for the
|
|
||||||
specific requirements.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
|
||||||
<http://www.gnu.org/licenses/>.
|
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
71
vendor/github.com/spf13/cobra/cobra/cmd/license_bsd_clause_2.go
generated
vendored
71
vendor/github.com/spf13/cobra/cobra/cmd/license_bsd_clause_2.go
generated
vendored
|
@ -1,71 +0,0 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initBsdClause2() {
|
|
||||||
Licenses["freebsd"] = License{
|
|
||||||
Name: "Simplified BSD License",
|
|
||||||
PossibleMatches: []string{"freebsd", "simpbsd", "simple bsd", "2-clause bsd",
|
|
||||||
"2 clause bsd", "simplified bsd license"},
|
|
||||||
Header: `All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer.
|
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer in the documentation
|
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
||||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
||||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
||||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
||||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
||||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
||||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
||||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
||||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
POSSIBILITY OF SUCH DAMAGE.`,
|
|
||||||
Text: `{{ .copyright }}
|
|
||||||
All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer.
|
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer in the documentation
|
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
||||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
||||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
||||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
||||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
||||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
||||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
78
vendor/github.com/spf13/cobra/cobra/cmd/license_bsd_clause_3.go
generated
vendored
78
vendor/github.com/spf13/cobra/cobra/cmd/license_bsd_clause_3.go
generated
vendored
|
@ -1,78 +0,0 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initBsdClause3() {
|
|
||||||
Licenses["bsd"] = License{
|
|
||||||
Name: "NewBSD",
|
|
||||||
PossibleMatches: []string{"bsd", "newbsd", "3 clause bsd", "3-clause bsd"},
|
|
||||||
Header: `All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer.
|
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer in the documentation
|
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors
|
|
||||||
may be used to endorse or promote products derived from this software
|
|
||||||
without specific prior written permission.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
||||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
||||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
||||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
||||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
||||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
||||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
||||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
||||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
POSSIBILITY OF SUCH DAMAGE.`,
|
|
||||||
Text: `{{ .copyright }}
|
|
||||||
All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer.
|
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer in the documentation
|
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors
|
|
||||||
may be used to endorse or promote products derived from this software
|
|
||||||
without specific prior written permission.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
||||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
||||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
||||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
||||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
||||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
||||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
376
vendor/github.com/spf13/cobra/cobra/cmd/license_gpl_2.go
generated
vendored
376
vendor/github.com/spf13/cobra/cobra/cmd/license_gpl_2.go
generated
vendored
|
@ -1,376 +0,0 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initGpl2() {
|
|
||||||
Licenses["gpl2"] = License{
|
|
||||||
Name: "GNU General Public License 2.0",
|
|
||||||
PossibleMatches: []string{"gpl2", "gnu gpl2", "gplv2"},
|
|
||||||
Header: `
|
|
||||||
This program is free software; you can redistribute it and/or
|
|
||||||
modify it under the terms of the GNU General Public License
|
|
||||||
as published by the Free Software Foundation; either version 2
|
|
||||||
of the License, or (at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.`,
|
|
||||||
Text: ` GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 2, June 1991
|
|
||||||
|
|
||||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The licenses for most software are designed to take away your
|
|
||||||
freedom to share and change it. By contrast, the GNU General Public
|
|
||||||
License is intended to guarantee your freedom to share and change free
|
|
||||||
software--to make sure the software is free for all its users. This
|
|
||||||
General Public License applies to most of the Free Software
|
|
||||||
Foundation's software and to any other program whose authors commit to
|
|
||||||
using it. (Some other Free Software Foundation software is covered by
|
|
||||||
the GNU Lesser General Public License instead.) You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
this service if you wish), that you receive source code or can get it
|
|
||||||
if you want it, that you can change the software or use pieces of it
|
|
||||||
in new free programs; and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to make restrictions that forbid
|
|
||||||
anyone to deny you these rights or to ask you to surrender the rights.
|
|
||||||
These restrictions translate to certain responsibilities for you if you
|
|
||||||
distribute copies of the software, or if you modify it.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must give the recipients all the rights that
|
|
||||||
you have. You must make sure that they, too, receive or can get the
|
|
||||||
source code. And you must show them these terms so they know their
|
|
||||||
rights.
|
|
||||||
|
|
||||||
We protect your rights with two steps: (1) copyright the software, and
|
|
||||||
(2) offer you this license which gives you legal permission to copy,
|
|
||||||
distribute and/or modify the software.
|
|
||||||
|
|
||||||
Also, for each author's protection and ours, we want to make certain
|
|
||||||
that everyone understands that there is no warranty for this free
|
|
||||||
software. If the software is modified by someone else and passed on, we
|
|
||||||
want its recipients to know that what they have is not the original, so
|
|
||||||
that any problems introduced by others will not reflect on the original
|
|
||||||
authors' reputations.
|
|
||||||
|
|
||||||
Finally, any free program is threatened constantly by software
|
|
||||||
patents. We wish to avoid the danger that redistributors of a free
|
|
||||||
program will individually obtain patent licenses, in effect making the
|
|
||||||
program proprietary. To prevent this, we have made it clear that any
|
|
||||||
patent must be licensed for everyone's free use or not licensed at all.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
||||||
|
|
||||||
0. This License applies to any program or other work which contains
|
|
||||||
a notice placed by the copyright holder saying it may be distributed
|
|
||||||
under the terms of this General Public License. The "Program", below,
|
|
||||||
refers to any such program or work, and a "work based on the Program"
|
|
||||||
means either the Program or any derivative work under copyright law:
|
|
||||||
that is to say, a work containing the Program or a portion of it,
|
|
||||||
either verbatim or with modifications and/or translated into another
|
|
||||||
language. (Hereinafter, translation is included without limitation in
|
|
||||||
the term "modification".) Each licensee is addressed as "you".
|
|
||||||
|
|
||||||
Activities other than copying, distribution and modification are not
|
|
||||||
covered by this License; they are outside its scope. The act of
|
|
||||||
running the Program is not restricted, and the output from the Program
|
|
||||||
is covered only if its contents constitute a work based on the
|
|
||||||
Program (independent of having been made by running the Program).
|
|
||||||
Whether that is true depends on what the Program does.
|
|
||||||
|
|
||||||
1. You may copy and distribute verbatim copies of the Program's
|
|
||||||
source code as you receive it, in any medium, provided that you
|
|
||||||
conspicuously and appropriately publish on each copy an appropriate
|
|
||||||
copyright notice and disclaimer of warranty; keep intact all the
|
|
||||||
notices that refer to this License and to the absence of any warranty;
|
|
||||||
and give any other recipients of the Program a copy of this License
|
|
||||||
along with the Program.
|
|
||||||
|
|
||||||
You may charge a fee for the physical act of transferring a copy, and
|
|
||||||
you may at your option offer warranty protection in exchange for a fee.
|
|
||||||
|
|
||||||
2. You may modify your copy or copies of the Program or any portion
|
|
||||||
of it, thus forming a work based on the Program, and copy and
|
|
||||||
distribute such modifications or work under the terms of Section 1
|
|
||||||
above, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) You must cause the modified files to carry prominent notices
|
|
||||||
stating that you changed the files and the date of any change.
|
|
||||||
|
|
||||||
b) You must cause any work that you distribute or publish, that in
|
|
||||||
whole or in part contains or is derived from the Program or any
|
|
||||||
part thereof, to be licensed as a whole at no charge to all third
|
|
||||||
parties under the terms of this License.
|
|
||||||
|
|
||||||
c) If the modified program normally reads commands interactively
|
|
||||||
when run, you must cause it, when started running for such
|
|
||||||
interactive use in the most ordinary way, to print or display an
|
|
||||||
announcement including an appropriate copyright notice and a
|
|
||||||
notice that there is no warranty (or else, saying that you provide
|
|
||||||
a warranty) and that users may redistribute the program under
|
|
||||||
these conditions, and telling the user how to view a copy of this
|
|
||||||
License. (Exception: if the Program itself is interactive but
|
|
||||||
does not normally print such an announcement, your work based on
|
|
||||||
the Program is not required to print an announcement.)
|
|
||||||
|
|
||||||
These requirements apply to the modified work as a whole. If
|
|
||||||
identifiable sections of that work are not derived from the Program,
|
|
||||||
and can be reasonably considered independent and separate works in
|
|
||||||
themselves, then this License, and its terms, do not apply to those
|
|
||||||
sections when you distribute them as separate works. But when you
|
|
||||||
distribute the same sections as part of a whole which is a work based
|
|
||||||
on the Program, the distribution of the whole must be on the terms of
|
|
||||||
this License, whose permissions for other licensees extend to the
|
|
||||||
entire whole, and thus to each and every part regardless of who wrote it.
|
|
||||||
|
|
||||||
Thus, it is not the intent of this section to claim rights or contest
|
|
||||||
your rights to work written entirely by you; rather, the intent is to
|
|
||||||
exercise the right to control the distribution of derivative or
|
|
||||||
collective works based on the Program.
|
|
||||||
|
|
||||||
In addition, mere aggregation of another work not based on the Program
|
|
||||||
with the Program (or with a work based on the Program) on a volume of
|
|
||||||
a storage or distribution medium does not bring the other work under
|
|
||||||
the scope of this License.
|
|
||||||
|
|
||||||
3. You may copy and distribute the Program (or a work based on it,
|
|
||||||
under Section 2) in object code or executable form under the terms of
|
|
||||||
Sections 1 and 2 above provided that you also do one of the following:
|
|
||||||
|
|
||||||
a) Accompany it with the complete corresponding machine-readable
|
|
||||||
source code, which must be distributed under the terms of Sections
|
|
||||||
1 and 2 above on a medium customarily used for software interchange; or,
|
|
||||||
|
|
||||||
b) Accompany it with a written offer, valid for at least three
|
|
||||||
years, to give any third party, for a charge no more than your
|
|
||||||
cost of physically performing source distribution, a complete
|
|
||||||
machine-readable copy of the corresponding source code, to be
|
|
||||||
distributed under the terms of Sections 1 and 2 above on a medium
|
|
||||||
customarily used for software interchange; or,
|
|
||||||
|
|
||||||
c) Accompany it with the information you received as to the offer
|
|
||||||
to distribute corresponding source code. (This alternative is
|
|
||||||
allowed only for noncommercial distribution and only if you
|
|
||||||
received the program in object code or executable form with such
|
|
||||||
an offer, in accord with Subsection b above.)
|
|
||||||
|
|
||||||
The source code for a work means the preferred form of the work for
|
|
||||||
making modifications to it. For an executable work, complete source
|
|
||||||
code means all the source code for all modules it contains, plus any
|
|
||||||
associated interface definition files, plus the scripts used to
|
|
||||||
control compilation and installation of the executable. However, as a
|
|
||||||
special exception, the source code distributed need not include
|
|
||||||
anything that is normally distributed (in either source or binary
|
|
||||||
form) with the major components (compiler, kernel, and so on) of the
|
|
||||||
operating system on which the executable runs, unless that component
|
|
||||||
itself accompanies the executable.
|
|
||||||
|
|
||||||
If distribution of executable or object code is made by offering
|
|
||||||
access to copy from a designated place, then offering equivalent
|
|
||||||
access to copy the source code from the same place counts as
|
|
||||||
distribution of the source code, even though third parties are not
|
|
||||||
compelled to copy the source along with the object code.
|
|
||||||
|
|
||||||
4. You may not copy, modify, sublicense, or distribute the Program
|
|
||||||
except as expressly provided under this License. Any attempt
|
|
||||||
otherwise to copy, modify, sublicense or distribute the Program is
|
|
||||||
void, and will automatically terminate your rights under this License.
|
|
||||||
However, parties who have received copies, or rights, from you under
|
|
||||||
this License will not have their licenses terminated so long as such
|
|
||||||
parties remain in full compliance.
|
|
||||||
|
|
||||||
5. You are not required to accept this License, since you have not
|
|
||||||
signed it. However, nothing else grants you permission to modify or
|
|
||||||
distribute the Program or its derivative works. These actions are
|
|
||||||
prohibited by law if you do not accept this License. Therefore, by
|
|
||||||
modifying or distributing the Program (or any work based on the
|
|
||||||
Program), you indicate your acceptance of this License to do so, and
|
|
||||||
all its terms and conditions for copying, distributing or modifying
|
|
||||||
the Program or works based on it.
|
|
||||||
|
|
||||||
6. Each time you redistribute the Program (or any work based on the
|
|
||||||
Program), the recipient automatically receives a license from the
|
|
||||||
original licensor to copy, distribute or modify the Program subject to
|
|
||||||
these terms and conditions. You may not impose any further
|
|
||||||
restrictions on the recipients' exercise of the rights granted herein.
|
|
||||||
You are not responsible for enforcing compliance by third parties to
|
|
||||||
this License.
|
|
||||||
|
|
||||||
7. If, as a consequence of a court judgment or allegation of patent
|
|
||||||
infringement or for any other reason (not limited to patent issues),
|
|
||||||
conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot
|
|
||||||
distribute so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you
|
|
||||||
may not distribute the Program at all. For example, if a patent
|
|
||||||
license would not permit royalty-free redistribution of the Program by
|
|
||||||
all those who receive copies directly or indirectly through you, then
|
|
||||||
the only way you could satisfy both it and this License would be to
|
|
||||||
refrain entirely from distribution of the Program.
|
|
||||||
|
|
||||||
If any portion of this section is held invalid or unenforceable under
|
|
||||||
any particular circumstance, the balance of the section is intended to
|
|
||||||
apply and the section as a whole is intended to apply in other
|
|
||||||
circumstances.
|
|
||||||
|
|
||||||
It is not the purpose of this section to induce you to infringe any
|
|
||||||
patents or other property right claims or to contest validity of any
|
|
||||||
such claims; this section has the sole purpose of protecting the
|
|
||||||
integrity of the free software distribution system, which is
|
|
||||||
implemented by public license practices. Many people have made
|
|
||||||
generous contributions to the wide range of software distributed
|
|
||||||
through that system in reliance on consistent application of that
|
|
||||||
system; it is up to the author/donor to decide if he or she is willing
|
|
||||||
to distribute software through any other system and a licensee cannot
|
|
||||||
impose that choice.
|
|
||||||
|
|
||||||
This section is intended to make thoroughly clear what is believed to
|
|
||||||
be a consequence of the rest of this License.
|
|
||||||
|
|
||||||
8. If the distribution and/or use of the Program is restricted in
|
|
||||||
certain countries either by patents or by copyrighted interfaces, the
|
|
||||||
original copyright holder who places the Program under this License
|
|
||||||
may add an explicit geographical distribution limitation excluding
|
|
||||||
those countries, so that distribution is permitted only in or among
|
|
||||||
countries not thus excluded. In such case, this License incorporates
|
|
||||||
the limitation as if written in the body of this License.
|
|
||||||
|
|
||||||
9. The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program
|
|
||||||
specifies a version number of this License which applies to it and "any
|
|
||||||
later version", you have the option of following the terms and conditions
|
|
||||||
either of that version or of any later version published by the Free
|
|
||||||
Software Foundation. If the Program does not specify a version number of
|
|
||||||
this License, you may choose any version ever published by the Free Software
|
|
||||||
Foundation.
|
|
||||||
|
|
||||||
10. If you wish to incorporate parts of the Program into other free
|
|
||||||
programs whose distribution conditions are different, write to the author
|
|
||||||
to ask for permission. For software which is copyrighted by the Free
|
|
||||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
||||||
make exceptions for this. Our decision will be guided by the two goals
|
|
||||||
of preserving the free status of all derivatives of our free software and
|
|
||||||
of promoting the sharing and reuse of software generally.
|
|
||||||
|
|
||||||
NO WARRANTY
|
|
||||||
|
|
||||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
||||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
||||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
||||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
||||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
||||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
||||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
||||||
REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
||||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
||||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
||||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
||||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
||||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
||||||
POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
convey the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software; you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation; either version 2 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along
|
|
||||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program is interactive, make it output a short notice like this
|
|
||||||
when it starts in an interactive mode:
|
|
||||||
|
|
||||||
Gnomovision version 69, Copyright (C) year name of author
|
|
||||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type 'show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands 'show w' and 'show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, the commands you use may
|
|
||||||
be called something other than 'show w' and 'show c'; they could even be
|
|
||||||
mouse-clicks or menu items--whatever suits your program.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or your
|
|
||||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
|
||||||
necessary. Here is a sample; alter the names:
|
|
||||||
|
|
||||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
|
||||||
'Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
||||||
|
|
||||||
<signature of Ty Coon>, 1 April 1989
|
|
||||||
Ty Coon, President of Vice
|
|
||||||
|
|
||||||
This General Public License does not permit incorporating your program into
|
|
||||||
proprietary programs. If your program is a subroutine library, you may
|
|
||||||
consider it more useful to permit linking proprietary applications with the
|
|
||||||
library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License.
|
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
711
vendor/github.com/spf13/cobra/cobra/cmd/license_gpl_3.go
generated
vendored
711
vendor/github.com/spf13/cobra/cobra/cmd/license_gpl_3.go
generated
vendored
|
@ -1,711 +0,0 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initGpl3() {
|
|
||||||
Licenses["gpl3"] = License{
|
|
||||||
Name: "GNU General Public License 3.0",
|
|
||||||
PossibleMatches: []string{"gpl3", "gplv3", "gpl", "gnu gpl3", "gnu gpl"},
|
|
||||||
Header: `
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.`,
|
|
||||||
Text: ` GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type 'show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands 'show w' and 'show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
186
vendor/github.com/spf13/cobra/cobra/cmd/license_lgpl.go
generated
vendored
186
vendor/github.com/spf13/cobra/cobra/cmd/license_lgpl.go
generated
vendored
|
@ -1,186 +0,0 @@
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initLgpl() {
|
|
||||||
Licenses["lgpl"] = License{
|
|
||||||
Name: "GNU Lesser General Public License",
|
|
||||||
PossibleMatches: []string{"lgpl", "lesser gpl", "gnu lgpl"},
|
|
||||||
Header: `
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU Lesser General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU Lesser General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Lesser General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.`,
|
|
||||||
Text: ` GNU LESSER GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
|
|
||||||
This version of the GNU Lesser General Public License incorporates
|
|
||||||
the terms and conditions of version 3 of the GNU General Public
|
|
||||||
License, supplemented by the additional permissions listed below.
|
|
||||||
|
|
||||||
0. Additional Definitions.
|
|
||||||
|
|
||||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
|
||||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
|
||||||
General Public License.
|
|
||||||
|
|
||||||
"The Library" refers to a covered work governed by this License,
|
|
||||||
other than an Application or a Combined Work as defined below.
|
|
||||||
|
|
||||||
An "Application" is any work that makes use of an interface provided
|
|
||||||
by the Library, but which is not otherwise based on the Library.
|
|
||||||
Defining a subclass of a class defined by the Library is deemed a mode
|
|
||||||
of using an interface provided by the Library.
|
|
||||||
|
|
||||||
A "Combined Work" is a work produced by combining or linking an
|
|
||||||
Application with the Library. The particular version of the Library
|
|
||||||
with which the Combined Work was made is also called the "Linked
|
|
||||||
Version".
|
|
||||||
|
|
||||||
The "Minimal Corresponding Source" for a Combined Work means the
|
|
||||||
Corresponding Source for the Combined Work, excluding any source code
|
|
||||||
for portions of the Combined Work that, considered in isolation, are
|
|
||||||
based on the Application, and not on the Linked Version.
|
|
||||||
|
|
||||||
The "Corresponding Application Code" for a Combined Work means the
|
|
||||||
object code and/or source code for the Application, including any data
|
|
||||||
and utility programs needed for reproducing the Combined Work from the
|
|
||||||
Application, but excluding the System Libraries of the Combined Work.
|
|
||||||
|
|
||||||
1. Exception to Section 3 of the GNU GPL.
|
|
||||||
|
|
||||||
You may convey a covered work under sections 3 and 4 of this License
|
|
||||||
without being bound by section 3 of the GNU GPL.
|
|
||||||
|
|
||||||
2. Conveying Modified Versions.
|
|
||||||
|
|
||||||
If you modify a copy of the Library, and, in your modifications, a
|
|
||||||
facility refers to a function or data to be supplied by an Application
|
|
||||||
that uses the facility (other than as an argument passed when the
|
|
||||||
facility is invoked), then you may convey a copy of the modified
|
|
||||||
version:
|
|
||||||
|
|
||||||
a) under this License, provided that you make a good faith effort to
|
|
||||||
ensure that, in the event an Application does not supply the
|
|
||||||
function or data, the facility still operates, and performs
|
|
||||||
whatever part of its purpose remains meaningful, or
|
|
||||||
|
|
||||||
b) under the GNU GPL, with none of the additional permissions of
|
|
||||||
this License applicable to that copy.
|
|
||||||
|
|
||||||
3. Object Code Incorporating Material from Library Header Files.
|
|
||||||
|
|
||||||
The object code form of an Application may incorporate material from
|
|
||||||
a header file that is part of the Library. You may convey such object
|
|
||||||
code under terms of your choice, provided that, if the incorporated
|
|
||||||
material is not limited to numerical parameters, data structure
|
|
||||||
layouts and accessors, or small macros, inline functions and templates
|
|
||||||
(ten or fewer lines in length), you do both of the following:
|
|
||||||
|
|
||||||
a) Give prominent notice with each copy of the object code that the
|
|
||||||
Library is used in it and that the Library and its use are
|
|
||||||
covered by this License.
|
|
||||||
|
|
||||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
|
||||||
document.
|
|
||||||
|
|
||||||
4. Combined Works.
|
|
||||||
|
|
||||||
You may convey a Combined Work under terms of your choice that,
|
|
||||||
taken together, effectively do not restrict modification of the
|
|
||||||
portions of the Library contained in the Combined Work and reverse
|
|
||||||
engineering for debugging such modifications, if you also do each of
|
|
||||||
the following:
|
|
||||||
|
|
||||||
a) Give prominent notice with each copy of the Combined Work that
|
|
||||||
the Library is used in it and that the Library and its use are
|
|
||||||
covered by this License.
|
|
||||||
|
|
||||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
|
||||||
document.
|
|
||||||
|
|
||||||
c) For a Combined Work that displays copyright notices during
|
|
||||||
execution, include the copyright notice for the Library among
|
|
||||||
these notices, as well as a reference directing the user to the
|
|
||||||
copies of the GNU GPL and this license document.
|
|
||||||
|
|
||||||
d) Do one of the following:
|
|
||||||
|
|
||||||
0) Convey the Minimal Corresponding Source under the terms of this
|
|
||||||
License, and the Corresponding Application Code in a form
|
|
||||||
suitable for, and under terms that permit, the user to
|
|
||||||
recombine or relink the Application with a modified version of
|
|
||||||
the Linked Version to produce a modified Combined Work, in the
|
|
||||||
manner specified by section 6 of the GNU GPL for conveying
|
|
||||||
Corresponding Source.
|
|
||||||
|
|
||||||
1) Use a suitable shared library mechanism for linking with the
|
|
||||||
Library. A suitable mechanism is one that (a) uses at run time
|
|
||||||
a copy of the Library already present on the user's computer
|
|
||||||
system, and (b) will operate properly with a modified version
|
|
||||||
of the Library that is interface-compatible with the Linked
|
|
||||||
Version.
|
|
||||||
|
|
||||||
e) Provide Installation Information, but only if you would otherwise
|
|
||||||
be required to provide such information under section 6 of the
|
|
||||||
GNU GPL, and only to the extent that such information is
|
|
||||||
necessary to install and execute a modified version of the
|
|
||||||
Combined Work produced by recombining or relinking the
|
|
||||||
Application with a modified version of the Linked Version. (If
|
|
||||||
you use option 4d0, the Installation Information must accompany
|
|
||||||
the Minimal Corresponding Source and Corresponding Application
|
|
||||||
Code. If you use option 4d1, you must provide the Installation
|
|
||||||
Information in the manner specified by section 6 of the GNU GPL
|
|
||||||
for conveying Corresponding Source.)
|
|
||||||
|
|
||||||
5. Combined Libraries.
|
|
||||||
|
|
||||||
You may place library facilities that are a work based on the
|
|
||||||
Library side by side in a single library together with other library
|
|
||||||
facilities that are not Applications and are not covered by this
|
|
||||||
License, and convey such a combined library under terms of your
|
|
||||||
choice, if you do both of the following:
|
|
||||||
|
|
||||||
a) Accompany the combined library with a copy of the same work based
|
|
||||||
on the Library, uncombined with any other library facilities,
|
|
||||||
conveyed under the terms of this License.
|
|
||||||
|
|
||||||
b) Give prominent notice with the combined library that part of it
|
|
||||||
is a work based on the Library, and explaining where to find the
|
|
||||||
accompanying uncombined form of the same work.
|
|
||||||
|
|
||||||
6. Revised Versions of the GNU Lesser General Public License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the GNU Lesser General Public License from time to time. Such new
|
|
||||||
versions will be similar in spirit to the present version, but may
|
|
||||||
differ in detail to address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Library as you received it specifies that a certain numbered version
|
|
||||||
of the GNU Lesser General Public License "or any later version"
|
|
||||||
applies to it, you have the option of following the terms and
|
|
||||||
conditions either of that published version or of any later version
|
|
||||||
published by the Free Software Foundation. If the Library as you
|
|
||||||
received it does not specify a version number of the GNU Lesser
|
|
||||||
General Public License, you may choose any version of the GNU Lesser
|
|
||||||
General Public License ever published by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Library as you received it specifies that a proxy can decide
|
|
||||||
whether future versions of the GNU Lesser General Public License shall
|
|
||||||
apply, that proxy's public statement of acceptance of any version is
|
|
||||||
permanent authorization for you to choose that version for the
|
|
||||||
Library.`,
|
|
||||||
}
|
|
||||||
}
|
|
63
vendor/github.com/spf13/cobra/cobra/cmd/license_mit.go
generated
vendored
63
vendor/github.com/spf13/cobra/cobra/cmd/license_mit.go
generated
vendored
|
@ -1,63 +0,0 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
func initMit() {
|
|
||||||
Licenses["mit"] = License{
|
|
||||||
Name: "MIT License",
|
|
||||||
PossibleMatches: []string{"mit"},
|
|
||||||
Header: `
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.`,
|
|
||||||
Text: `The MIT License (MIT)
|
|
||||||
|
|
||||||
{{ .copyright }}
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
`,
|
|
||||||
}
|
|
||||||
}
|
|
118
vendor/github.com/spf13/cobra/cobra/cmd/licenses.go
generated
vendored
118
vendor/github.com/spf13/cobra/cobra/cmd/licenses.go
generated
vendored
|
@ -1,118 +0,0 @@
|
||||||
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
// Parts inspired by https://github.com/ryanuber/go-license
|
|
||||||
|
|
||||||
package cmd
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/viper"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Licenses contains all possible licenses a user can choose from.
|
|
||||||
var Licenses = make(map[string]License)
|
|
||||||
|
|
||||||
// License represents a software license agreement, containing the Name of
|
|
||||||
// the license, its possible matches (on the command line as given to cobra),
|
|
||||||
// the header to be used with each file on the file's creating, and the text
|
|
||||||
// of the license
|
|
||||||
type License struct {
|
|
||||||
Name string // The type of license in use
|
|
||||||
PossibleMatches []string // Similar names to guess
|
|
||||||
Text string // License text data
|
|
||||||
Header string // License header for source files
|
|
||||||
}
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
// Allows a user to not use a license.
|
|
||||||
Licenses["none"] = License{"None", []string{"none", "false"}, "", ""}
|
|
||||||
|
|
||||||
initApache2()
|
|
||||||
initMit()
|
|
||||||
initBsdClause3()
|
|
||||||
initBsdClause2()
|
|
||||||
initGpl2()
|
|
||||||
initGpl3()
|
|
||||||
initLgpl()
|
|
||||||
initAgpl()
|
|
||||||
}
|
|
||||||
|
|
||||||
// getLicense returns license specified by user in flag or in config.
|
|
||||||
// If user didn't specify the license, it returns Apache License 2.0.
|
|
||||||
//
|
|
||||||
// TODO: Inspect project for existing license
|
|
||||||
func getLicense() License {
|
|
||||||
// If explicitly flagged, use that.
|
|
||||||
if userLicense != "" {
|
|
||||||
return findLicense(userLicense)
|
|
||||||
}
|
|
||||||
|
|
||||||
// If user wants to have custom license, use that.
|
|
||||||
if viper.IsSet("license.header") || viper.IsSet("license.text") {
|
|
||||||
return License{Header: viper.GetString("license.header"),
|
|
||||||
Text: viper.GetString("license.text")}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If user wants to have built-in license, use that.
|
|
||||||
if viper.IsSet("license") {
|
|
||||||
return findLicense(viper.GetString("license"))
|
|
||||||
}
|
|
||||||
|
|
||||||
// If user didn't set any license, use Apache 2.0 by default.
|
|
||||||
return Licenses["apache"]
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyrightLine() string {
|
|
||||||
author := viper.GetString("author")
|
|
||||||
|
|
||||||
year := viper.GetString("year") // For tests.
|
|
||||||
if year == "" {
|
|
||||||
year = time.Now().Format("2006")
|
|
||||||
}
|
|
||||||
|
|
||||||
return "Copyright © " + year + " " + author
|
|
||||||
}
|
|
||||||
|
|
||||||
// findLicense looks for License object of built-in licenses.
|
|
||||||
// If it didn't find license, then the app will be terminated and
|
|
||||||
// error will be printed.
|
|
||||||
func findLicense(name string) License {
|
|
||||||
found := matchLicense(name)
|
|
||||||
if found == "" {
|
|
||||||
er("unknown license: " + name)
|
|
||||||
}
|
|
||||||
return Licenses[found]
|
|
||||||
}
|
|
||||||
|
|
||||||
// matchLicense compares the given a license name
|
|
||||||
// to PossibleMatches of all built-in licenses.
|
|
||||||
// It returns blank string, if name is blank string or it didn't find
|
|
||||||
// then appropriate match to name.
|
|
||||||
func matchLicense(name string) string {
|
|
||||||
if name == "" {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
for key, lic := range Licenses {
|
|
||||||
for _, match := range lic.PossibleMatches {
|
|
||||||
if strings.EqualFold(name, match) {
|
|
||||||
return key
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return ""
|
|
||||||
}
|
|
22
vendor/github.com/spf13/jwalterweatherman/.gitignore
generated
vendored
22
vendor/github.com/spf13/jwalterweatherman/.gitignore
generated
vendored
|
@ -1,22 +0,0 @@
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
*.exe
|
|
148
vendor/github.com/spf13/jwalterweatherman/README.md
generated
vendored
148
vendor/github.com/spf13/jwalterweatherman/README.md
generated
vendored
|
@ -1,148 +0,0 @@
|
||||||
jWalterWeatherman
|
|
||||||
=================
|
|
||||||
|
|
||||||
Seamless printing to the terminal (stdout) and logging to a io.Writer
|
|
||||||
(file) that’s as easy to use as fmt.Println.
|
|
||||||
|
|
||||||
![and_that__s_why_you_always_leave_a_note_by_jonnyetc-d57q7um](https://cloud.githubusercontent.com/assets/173412/11002937/ccd01654-847d-11e5-828e-12ebaf582eaf.jpg)
|
|
||||||
Graphic by [JonnyEtc](http://jonnyetc.deviantart.com/art/And-That-s-Why-You-Always-Leave-a-Note-315311422)
|
|
||||||
|
|
||||||
JWW is primarily a wrapper around the excellent standard log library. It
|
|
||||||
provides a few advantages over using the standard log library alone.
|
|
||||||
|
|
||||||
1. Ready to go out of the box.
|
|
||||||
2. One library for both printing to the terminal and logging (to files).
|
|
||||||
3. Really easy to log to either a temp file or a file you specify.
|
|
||||||
|
|
||||||
|
|
||||||
I really wanted a very straightforward library that could seamlessly do
|
|
||||||
the following things.
|
|
||||||
|
|
||||||
1. Replace all the println, printf, etc statements thought my code with
|
|
||||||
something more useful
|
|
||||||
2. Allow the user to easily control what levels are printed to stdout
|
|
||||||
3. Allow the user to easily control what levels are logged
|
|
||||||
4. Provide an easy mechanism (like fmt.Println) to print info to the user
|
|
||||||
which can be easily logged as well
|
|
||||||
5. Due to 2 & 3 provide easy verbose mode for output and logs
|
|
||||||
6. Not have any unnecessary initialization cruft. Just use it.
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Step 1. Use it
|
|
||||||
Put calls throughout your source based on type of feedback.
|
|
||||||
No initialization or setup needs to happen. Just start calling things.
|
|
||||||
|
|
||||||
Available Loggers are:
|
|
||||||
|
|
||||||
* TRACE
|
|
||||||
* DEBUG
|
|
||||||
* INFO
|
|
||||||
* WARN
|
|
||||||
* ERROR
|
|
||||||
* CRITICAL
|
|
||||||
* FATAL
|
|
||||||
|
|
||||||
These each are loggers based on the log standard library and follow the
|
|
||||||
standard usage. Eg.
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
jww "github.com/spf13/jwalterweatherman"
|
|
||||||
)
|
|
||||||
|
|
||||||
...
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
|
|
||||||
// This is a pretty serious error and the user should know about
|
|
||||||
// it. It will be printed to the terminal as well as logged under the
|
|
||||||
// default thresholds.
|
|
||||||
|
|
||||||
jww.ERROR.Println(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err2 != nil {
|
|
||||||
// This error isn’t going to materially change the behavior of the
|
|
||||||
// application, but it’s something that may not be what the user
|
|
||||||
// expects. Under the default thresholds, Warn will be logged, but
|
|
||||||
// not printed to the terminal.
|
|
||||||
|
|
||||||
jww.WARN.Println(err2)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Information that’s relevant to what’s happening, but not very
|
|
||||||
// important for the user. Under the default thresholds this will be
|
|
||||||
// discarded.
|
|
||||||
|
|
||||||
jww.INFO.Printf("information %q", response)
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
NOTE: You can also use the library in a non-global setting by creating an instance of a Notebook:
|
|
||||||
|
|
||||||
```go
|
|
||||||
notepad = jww.NewNotepad(jww.LevelInfo, jww.LevelTrace, os.Stdout, ioutil.Discard, "", log.Ldate|log.Ltime)
|
|
||||||
notepad.WARN.Println("Some warning"")
|
|
||||||
```
|
|
||||||
|
|
||||||
_Why 7 levels?_
|
|
||||||
|
|
||||||
Maybe you think that 7 levels are too much for any application... and you
|
|
||||||
are probably correct. Just because there are seven levels doesn’t mean
|
|
||||||
that you should be using all 7 levels. Pick the right set for your needs.
|
|
||||||
Remember they only have to mean something to your project.
|
|
||||||
|
|
||||||
## Step 2. Optionally configure JWW
|
|
||||||
|
|
||||||
Under the default thresholds :
|
|
||||||
|
|
||||||
* Debug, Trace & Info goto /dev/null
|
|
||||||
* Warn and above is logged (when a log file/io.Writer is provided)
|
|
||||||
* Error and above is printed to the terminal (stdout)
|
|
||||||
|
|
||||||
### Changing the thresholds
|
|
||||||
|
|
||||||
The threshold can be changed at any time, but will only affect calls that
|
|
||||||
execute after the change was made.
|
|
||||||
|
|
||||||
This is very useful if your application has a verbose mode. Of course you
|
|
||||||
can decide what verbose means to you or even have multiple levels of
|
|
||||||
verbosity.
|
|
||||||
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
jww "github.com/spf13/jwalterweatherman"
|
|
||||||
)
|
|
||||||
|
|
||||||
if Verbose {
|
|
||||||
jww.SetLogThreshold(jww.LevelTrace)
|
|
||||||
jww.SetStdoutThreshold(jww.LevelInfo)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that JWW's own internal output uses log levels as well, so set the log
|
|
||||||
level before making any other calls if you want to see what it's up to.
|
|
||||||
|
|
||||||
|
|
||||||
### Setting a log file
|
|
||||||
|
|
||||||
JWW can log to any `io.Writer`:
|
|
||||||
|
|
||||||
|
|
||||||
```go
|
|
||||||
|
|
||||||
jww.SetLogOutput(customWriter)
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
# More information
|
|
||||||
|
|
||||||
This is an early release. I’ve been using it for a while and this is the
|
|
||||||
third interface I’ve tried. I like this one pretty well, but no guarantees
|
|
||||||
that it won’t change a bit.
|
|
||||||
|
|
||||||
I wrote this for use in [hugo](https://gohugo.io). If you are looking
|
|
||||||
for a static website engine that’s super fast please checkout Hugo.
|
|
2
vendor/github.com/spf13/pflag/.gitignore
generated
vendored
2
vendor/github.com/spf13/pflag/.gitignore
generated
vendored
|
@ -1,2 +0,0 @@
|
||||||
.idea/*
|
|
||||||
|
|
21
vendor/github.com/spf13/pflag/.travis.yml
generated
vendored
21
vendor/github.com/spf13/pflag/.travis.yml
generated
vendored
|
@ -1,21 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.7.3
|
|
||||||
- 1.8.1
|
|
||||||
- tip
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
|
|
||||||
install:
|
|
||||||
- go get github.com/golang/lint/golint
|
|
||||||
- export PATH=$GOPATH/bin:$PATH
|
|
||||||
- go install ./...
|
|
||||||
|
|
||||||
script:
|
|
||||||
- verify/all.sh -v
|
|
||||||
- go test ./...
|
|
296
vendor/github.com/spf13/pflag/README.md
generated
vendored
296
vendor/github.com/spf13/pflag/README.md
generated
vendored
|
@ -1,296 +0,0 @@
|
||||||
[![Build Status](https://travis-ci.org/spf13/pflag.svg?branch=master)](https://travis-ci.org/spf13/pflag)
|
|
||||||
[![Go Report Card](https://goreportcard.com/badge/github.com/spf13/pflag)](https://goreportcard.com/report/github.com/spf13/pflag)
|
|
||||||
[![GoDoc](https://godoc.org/github.com/spf13/pflag?status.svg)](https://godoc.org/github.com/spf13/pflag)
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
pflag is a drop-in replacement for Go's flag package, implementing
|
|
||||||
POSIX/GNU-style --flags.
|
|
||||||
|
|
||||||
pflag is compatible with the [GNU extensions to the POSIX recommendations
|
|
||||||
for command-line options][1]. For a more precise description, see the
|
|
||||||
"Command-line flag syntax" section below.
|
|
||||||
|
|
||||||
[1]: http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
|
|
||||||
|
|
||||||
pflag is available under the same style of BSD license as the Go language,
|
|
||||||
which can be found in the LICENSE file.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
pflag is available using the standard `go get` command.
|
|
||||||
|
|
||||||
Install by running:
|
|
||||||
|
|
||||||
go get github.com/spf13/pflag
|
|
||||||
|
|
||||||
Run tests by running:
|
|
||||||
|
|
||||||
go test github.com/spf13/pflag
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
pflag is a drop-in replacement of Go's native flag package. If you import
|
|
||||||
pflag under the name "flag" then all code should continue to function
|
|
||||||
with no changes.
|
|
||||||
|
|
||||||
``` go
|
|
||||||
import flag "github.com/spf13/pflag"
|
|
||||||
```
|
|
||||||
|
|
||||||
There is one exception to this: if you directly instantiate the Flag struct
|
|
||||||
there is one more field "Shorthand" that you will need to set.
|
|
||||||
Most code never instantiates this struct directly, and instead uses
|
|
||||||
functions such as String(), BoolVar(), and Var(), and is therefore
|
|
||||||
unaffected.
|
|
||||||
|
|
||||||
Define flags using flag.String(), Bool(), Int(), etc.
|
|
||||||
|
|
||||||
This declares an integer flag, -flagname, stored in the pointer ip, with type *int.
|
|
||||||
|
|
||||||
``` go
|
|
||||||
var ip *int = flag.Int("flagname", 1234, "help message for flagname")
|
|
||||||
```
|
|
||||||
|
|
||||||
If you like, you can bind the flag to a variable using the Var() functions.
|
|
||||||
|
|
||||||
``` go
|
|
||||||
var flagvar int
|
|
||||||
func init() {
|
|
||||||
flag.IntVar(&flagvar, "flagname", 1234, "help message for flagname")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Or you can create custom flags that satisfy the Value interface (with
|
|
||||||
pointer receivers) and couple them to flag parsing by
|
|
||||||
|
|
||||||
``` go
|
|
||||||
flag.Var(&flagVal, "name", "help message for flagname")
|
|
||||||
```
|
|
||||||
|
|
||||||
For such flags, the default value is just the initial value of the variable.
|
|
||||||
|
|
||||||
After all flags are defined, call
|
|
||||||
|
|
||||||
``` go
|
|
||||||
flag.Parse()
|
|
||||||
```
|
|
||||||
|
|
||||||
to parse the command line into the defined flags.
|
|
||||||
|
|
||||||
Flags may then be used directly. If you're using the flags themselves,
|
|
||||||
they are all pointers; if you bind to variables, they're values.
|
|
||||||
|
|
||||||
``` go
|
|
||||||
fmt.Println("ip has value ", *ip)
|
|
||||||
fmt.Println("flagvar has value ", flagvar)
|
|
||||||
```
|
|
||||||
|
|
||||||
There are helpers function to get values later if you have the FlagSet but
|
|
||||||
it was difficult to keep up with all of the flag pointers in your code.
|
|
||||||
If you have a pflag.FlagSet with a flag called 'flagname' of type int you
|
|
||||||
can use GetInt() to get the int value. But notice that 'flagname' must exist
|
|
||||||
and it must be an int. GetString("flagname") will fail.
|
|
||||||
|
|
||||||
``` go
|
|
||||||
i, err := flagset.GetInt("flagname")
|
|
||||||
```
|
|
||||||
|
|
||||||
After parsing, the arguments after the flag are available as the
|
|
||||||
slice flag.Args() or individually as flag.Arg(i).
|
|
||||||
The arguments are indexed from 0 through flag.NArg()-1.
|
|
||||||
|
|
||||||
The pflag package also defines some new functions that are not in flag,
|
|
||||||
that give one-letter shorthands for flags. You can use these by appending
|
|
||||||
'P' to the name of any function that defines a flag.
|
|
||||||
|
|
||||||
``` go
|
|
||||||
var ip = flag.IntP("flagname", "f", 1234, "help message")
|
|
||||||
var flagvar bool
|
|
||||||
func init() {
|
|
||||||
flag.BoolVarP(&flagvar, "boolname", "b", true, "help message")
|
|
||||||
}
|
|
||||||
flag.VarP(&flagVal, "varname", "v", "help message")
|
|
||||||
```
|
|
||||||
|
|
||||||
Shorthand letters can be used with single dashes on the command line.
|
|
||||||
Boolean shorthand flags can be combined with other shorthand flags.
|
|
||||||
|
|
||||||
The default set of command-line flags is controlled by
|
|
||||||
top-level functions. The FlagSet type allows one to define
|
|
||||||
independent sets of flags, such as to implement subcommands
|
|
||||||
in a command-line interface. The methods of FlagSet are
|
|
||||||
analogous to the top-level functions for the command-line
|
|
||||||
flag set.
|
|
||||||
|
|
||||||
## Setting no option default values for flags
|
|
||||||
|
|
||||||
After you create a flag it is possible to set the pflag.NoOptDefVal for
|
|
||||||
the given flag. Doing this changes the meaning of the flag slightly. If
|
|
||||||
a flag has a NoOptDefVal and the flag is set on the command line without
|
|
||||||
an option the flag will be set to the NoOptDefVal. For example given:
|
|
||||||
|
|
||||||
``` go
|
|
||||||
var ip = flag.IntP("flagname", "f", 1234, "help message")
|
|
||||||
flag.Lookup("flagname").NoOptDefVal = "4321"
|
|
||||||
```
|
|
||||||
|
|
||||||
Would result in something like
|
|
||||||
|
|
||||||
| Parsed Arguments | Resulting Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| --flagname=1357 | ip=1357 |
|
|
||||||
| --flagname | ip=4321 |
|
|
||||||
| [nothing] | ip=1234 |
|
|
||||||
|
|
||||||
## Command line flag syntax
|
|
||||||
|
|
||||||
```
|
|
||||||
--flag // boolean flags, or flags with no option default values
|
|
||||||
--flag x // only on flags without a default value
|
|
||||||
--flag=x
|
|
||||||
```
|
|
||||||
|
|
||||||
Unlike the flag package, a single dash before an option means something
|
|
||||||
different than a double dash. Single dashes signify a series of shorthand
|
|
||||||
letters for flags. All but the last shorthand letter must be boolean flags
|
|
||||||
or a flag with a default value
|
|
||||||
|
|
||||||
```
|
|
||||||
// boolean or flags where the 'no option default value' is set
|
|
||||||
-f
|
|
||||||
-f=true
|
|
||||||
-abc
|
|
||||||
but
|
|
||||||
-b true is INVALID
|
|
||||||
|
|
||||||
// non-boolean and flags without a 'no option default value'
|
|
||||||
-n 1234
|
|
||||||
-n=1234
|
|
||||||
-n1234
|
|
||||||
|
|
||||||
// mixed
|
|
||||||
-abcs "hello"
|
|
||||||
-absd="hello"
|
|
||||||
-abcs1234
|
|
||||||
```
|
|
||||||
|
|
||||||
Flag parsing stops after the terminator "--". Unlike the flag package,
|
|
||||||
flags can be interspersed with arguments anywhere on the command line
|
|
||||||
before this terminator.
|
|
||||||
|
|
||||||
Integer flags accept 1234, 0664, 0x1234 and may be negative.
|
|
||||||
Boolean flags (in their long form) accept 1, 0, t, f, true, false,
|
|
||||||
TRUE, FALSE, True, False.
|
|
||||||
Duration flags accept any input valid for time.ParseDuration.
|
|
||||||
|
|
||||||
## Mutating or "Normalizing" Flag names
|
|
||||||
|
|
||||||
It is possible to set a custom flag name 'normalization function.' It allows flag names to be mutated both when created in the code and when used on the command line to some 'normalized' form. The 'normalized' form is used for comparison. Two examples of using the custom normalization func follow.
|
|
||||||
|
|
||||||
**Example #1**: You want -, _, and . in flags to compare the same. aka --my-flag == --my_flag == --my.flag
|
|
||||||
|
|
||||||
``` go
|
|
||||||
func wordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
|
||||||
from := []string{"-", "_"}
|
|
||||||
to := "."
|
|
||||||
for _, sep := range from {
|
|
||||||
name = strings.Replace(name, sep, to, -1)
|
|
||||||
}
|
|
||||||
return pflag.NormalizedName(name)
|
|
||||||
}
|
|
||||||
|
|
||||||
myFlagSet.SetNormalizeFunc(wordSepNormalizeFunc)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Example #2**: You want to alias two flags. aka --old-flag-name == --new-flag-name
|
|
||||||
|
|
||||||
``` go
|
|
||||||
func aliasNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
|
||||||
switch name {
|
|
||||||
case "old-flag-name":
|
|
||||||
name = "new-flag-name"
|
|
||||||
break
|
|
||||||
}
|
|
||||||
return pflag.NormalizedName(name)
|
|
||||||
}
|
|
||||||
|
|
||||||
myFlagSet.SetNormalizeFunc(aliasNormalizeFunc)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Deprecating a flag or its shorthand
|
|
||||||
It is possible to deprecate a flag, or just its shorthand. Deprecating a flag/shorthand hides it from help text and prints a usage message when the deprecated flag/shorthand is used.
|
|
||||||
|
|
||||||
**Example #1**: You want to deprecate a flag named "badflag" as well as inform the users what flag they should use instead.
|
|
||||||
```go
|
|
||||||
// deprecate a flag by specifying its name and a usage message
|
|
||||||
flags.MarkDeprecated("badflag", "please use --good-flag instead")
|
|
||||||
```
|
|
||||||
This hides "badflag" from help text, and prints `Flag --badflag has been deprecated, please use --good-flag instead` when "badflag" is used.
|
|
||||||
|
|
||||||
**Example #2**: You want to keep a flag name "noshorthandflag" but deprecate its shortname "n".
|
|
||||||
```go
|
|
||||||
// deprecate a flag shorthand by specifying its flag name and a usage message
|
|
||||||
flags.MarkShorthandDeprecated("noshorthandflag", "please use --noshorthandflag only")
|
|
||||||
```
|
|
||||||
This hides the shortname "n" from help text, and prints `Flag shorthand -n has been deprecated, please use --noshorthandflag only` when the shorthand "n" is used.
|
|
||||||
|
|
||||||
Note that usage message is essential here, and it should not be empty.
|
|
||||||
|
|
||||||
## Hidden flags
|
|
||||||
It is possible to mark a flag as hidden, meaning it will still function as normal, however will not show up in usage/help text.
|
|
||||||
|
|
||||||
**Example**: You have a flag named "secretFlag" that you need for internal use only and don't want it showing up in help text, or for its usage text to be available.
|
|
||||||
```go
|
|
||||||
// hide a flag by specifying its name
|
|
||||||
flags.MarkHidden("secretFlag")
|
|
||||||
```
|
|
||||||
|
|
||||||
## Disable sorting of flags
|
|
||||||
`pflag` allows you to disable sorting of flags for help and usage message.
|
|
||||||
|
|
||||||
**Example**:
|
|
||||||
```go
|
|
||||||
flags.BoolP("verbose", "v", false, "verbose output")
|
|
||||||
flags.String("coolflag", "yeaah", "it's really cool flag")
|
|
||||||
flags.Int("usefulflag", 777, "sometimes it's very useful")
|
|
||||||
flags.SortFlags = false
|
|
||||||
flags.PrintDefaults()
|
|
||||||
```
|
|
||||||
**Output**:
|
|
||||||
```
|
|
||||||
-v, --verbose verbose output
|
|
||||||
--coolflag string it's really cool flag (default "yeaah")
|
|
||||||
--usefulflag int sometimes it's very useful (default 777)
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Supporting Go flags when using pflag
|
|
||||||
In order to support flags defined using Go's `flag` package, they must be added to the `pflag` flagset. This is usually necessary
|
|
||||||
to support flags defined by third-party dependencies (e.g. `golang/glog`).
|
|
||||||
|
|
||||||
**Example**: You want to add the Go flags to the `CommandLine` flagset
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
goflag "flag"
|
|
||||||
flag "github.com/spf13/pflag"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ip *int = flag.Int("flagname", 1234, "help message for flagname")
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
flag.CommandLine.AddGoFlagSet(goflag.CommandLine)
|
|
||||||
flag.Parse()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## More info
|
|
||||||
|
|
||||||
You can see the full reference documentation of the pflag package
|
|
||||||
[at godoc.org][3], or through go's standard documentation system by
|
|
||||||
running `godoc -http=:6060` and browsing to
|
|
||||||
[http://localhost:6060/pkg/github.com/spf13/pflag][2] after
|
|
||||||
installation.
|
|
||||||
|
|
||||||
[2]: http://localhost:6060/pkg/github.com/spf13/pflag
|
|
||||||
[3]: http://godoc.org/github.com/spf13/pflag
|
|
24
vendor/github.com/spf13/viper/.gitignore
generated
vendored
24
vendor/github.com/spf13/viper/.gitignore
generated
vendored
|
@ -1,24 +0,0 @@
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
*.exe
|
|
||||||
*.test
|
|
||||||
*.bench
|
|
28
vendor/github.com/spf13/viper/.travis.yml
generated
vendored
28
vendor/github.com/spf13/viper/.travis.yml
generated
vendored
|
@ -1,28 +0,0 @@
|
||||||
go_import_path: github.com/spf13/viper
|
|
||||||
|
|
||||||
language: go
|
|
||||||
go:
|
|
||||||
- 1.7.x
|
|
||||||
- 1.8.x
|
|
||||||
- 1.9.x
|
|
||||||
- tip
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
fast_finish: true
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go install ./...
|
|
||||||
- diff -u <(echo -n) <(gofmt -d .)
|
|
||||||
- go test -v ./...
|
|
||||||
|
|
||||||
after_success:
|
|
||||||
- go get -u -d github.com/spf13/hugo
|
|
||||||
- cd $GOPATH/src/github.com/spf13/hugo && make && ./hugo -s docs && cd -
|
|
||||||
|
|
||||||
sudo: false
|
|
643
vendor/github.com/spf13/viper/README.md
generated
vendored
643
vendor/github.com/spf13/viper/README.md
generated
vendored
|
@ -1,643 +0,0 @@
|
||||||
![viper logo](https://cloud.githubusercontent.com/assets/173412/10886745/998df88a-8151-11e5-9448-4736db51020d.png)
|
|
||||||
|
|
||||||
Go configuration with fangs!
|
|
||||||
|
|
||||||
Many Go projects are built using Viper including:
|
|
||||||
|
|
||||||
* [Hugo](http://gohugo.io)
|
|
||||||
* [EMC RexRay](http://rexray.readthedocs.org/en/stable/)
|
|
||||||
* [Imgur’s Incus](https://github.com/Imgur/incus)
|
|
||||||
* [Nanobox](https://github.com/nanobox-io/nanobox)/[Nanopack](https://github.com/nanopack)
|
|
||||||
* [Docker Notary](https://github.com/docker/Notary)
|
|
||||||
* [BloomApi](https://www.bloomapi.com/)
|
|
||||||
* [doctl](https://github.com/digitalocean/doctl)
|
|
||||||
* [Clairctl](https://github.com/jgsqware/clairctl)
|
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/spf13/viper.svg)](https://travis-ci.org/spf13/viper) [![Join the chat at https://gitter.im/spf13/viper](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/spf13/viper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GoDoc](https://godoc.org/github.com/spf13/viper?status.svg)](https://godoc.org/github.com/spf13/viper)
|
|
||||||
|
|
||||||
|
|
||||||
## What is Viper?
|
|
||||||
|
|
||||||
Viper is a complete configuration solution for Go applications including 12-Factor apps. It is designed
|
|
||||||
to work within an application, and can handle all types of configuration needs
|
|
||||||
and formats. It supports:
|
|
||||||
|
|
||||||
* setting defaults
|
|
||||||
* reading from JSON, TOML, YAML, HCL, and Java properties config files
|
|
||||||
* live watching and re-reading of config files (optional)
|
|
||||||
* reading from environment variables
|
|
||||||
* reading from remote config systems (etcd or Consul), and watching changes
|
|
||||||
* reading from command line flags
|
|
||||||
* reading from buffer
|
|
||||||
* setting explicit values
|
|
||||||
|
|
||||||
Viper can be thought of as a registry for all of your applications
|
|
||||||
configuration needs.
|
|
||||||
|
|
||||||
## Why Viper?
|
|
||||||
|
|
||||||
When building a modern application, you don’t want to worry about
|
|
||||||
configuration file formats; you want to focus on building awesome software.
|
|
||||||
Viper is here to help with that.
|
|
||||||
|
|
||||||
Viper does the following for you:
|
|
||||||
|
|
||||||
1. Find, load, and unmarshal a configuration file in JSON, TOML, YAML, HCL, or Java properties formats.
|
|
||||||
2. Provide a mechanism to set default values for your different
|
|
||||||
configuration options.
|
|
||||||
3. Provide a mechanism to set override values for options specified through
|
|
||||||
command line flags.
|
|
||||||
4. Provide an alias system to easily rename parameters without breaking existing
|
|
||||||
code.
|
|
||||||
5. Make it easy to tell the difference between when a user has provided a
|
|
||||||
command line or config file which is the same as the default.
|
|
||||||
|
|
||||||
Viper uses the following precedence order. Each item takes precedence over the
|
|
||||||
item below it:
|
|
||||||
|
|
||||||
* explicit call to Set
|
|
||||||
* flag
|
|
||||||
* env
|
|
||||||
* config
|
|
||||||
* key/value store
|
|
||||||
* default
|
|
||||||
|
|
||||||
Viper configuration keys are case insensitive.
|
|
||||||
|
|
||||||
## Putting Values into Viper
|
|
||||||
|
|
||||||
### Establishing Defaults
|
|
||||||
|
|
||||||
A good configuration system will support default values. A default value is not
|
|
||||||
required for a key, but it’s useful in the event that a key hasn’t been set via
|
|
||||||
config file, environment variable, remote configuration or flag.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.SetDefault("ContentDir", "content")
|
|
||||||
viper.SetDefault("LayoutDir", "layouts")
|
|
||||||
viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"})
|
|
||||||
```
|
|
||||||
|
|
||||||
### Reading Config Files
|
|
||||||
|
|
||||||
Viper requires minimal configuration so it knows where to look for config files.
|
|
||||||
Viper supports JSON, TOML, YAML, HCL, and Java Properties files. Viper can search multiple paths, but
|
|
||||||
currently a single Viper instance only supports a single configuration file.
|
|
||||||
Viper does not default to any configuration search paths leaving defaults decision
|
|
||||||
to an application.
|
|
||||||
|
|
||||||
Here is an example of how to use Viper to search for and read a configuration file.
|
|
||||||
None of the specific paths are required, but at least one path should be provided
|
|
||||||
where a configuration file is expected.
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.SetConfigName("config") // name of config file (without extension)
|
|
||||||
viper.AddConfigPath("/etc/appname/") // path to look for the config file in
|
|
||||||
viper.AddConfigPath("$HOME/.appname") // call multiple times to add many search paths
|
|
||||||
viper.AddConfigPath(".") // optionally look for config in the working directory
|
|
||||||
err := viper.ReadInConfig() // Find and read the config file
|
|
||||||
if err != nil { // Handle errors reading the config file
|
|
||||||
panic(fmt.Errorf("Fatal error config file: %s \n", err))
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Watching and re-reading config files
|
|
||||||
|
|
||||||
Viper supports the ability to have your application live read a config file while running.
|
|
||||||
|
|
||||||
Gone are the days of needing to restart a server to have a config take effect,
|
|
||||||
viper powered applications can read an update to a config file while running and
|
|
||||||
not miss a beat.
|
|
||||||
|
|
||||||
Simply tell the viper instance to watchConfig.
|
|
||||||
Optionally you can provide a function for Viper to run each time a change occurs.
|
|
||||||
|
|
||||||
**Make sure you add all of the configPaths prior to calling `WatchConfig()`**
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.WatchConfig()
|
|
||||||
viper.OnConfigChange(func(e fsnotify.Event) {
|
|
||||||
fmt.Println("Config file changed:", e.Name)
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### Reading Config from io.Reader
|
|
||||||
|
|
||||||
Viper predefines many configuration sources such as files, environment
|
|
||||||
variables, flags, and remote K/V store, but you are not bound to them. You can
|
|
||||||
also implement your own required configuration source and feed it to viper.
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.SetConfigType("yaml") // or viper.SetConfigType("YAML")
|
|
||||||
|
|
||||||
// any approach to require this configuration into your program.
|
|
||||||
var yamlExample = []byte(`
|
|
||||||
Hacker: true
|
|
||||||
name: steve
|
|
||||||
hobbies:
|
|
||||||
- skateboarding
|
|
||||||
- snowboarding
|
|
||||||
- go
|
|
||||||
clothing:
|
|
||||||
jacket: leather
|
|
||||||
trousers: denim
|
|
||||||
age: 35
|
|
||||||
eyes : brown
|
|
||||||
beard: true
|
|
||||||
`)
|
|
||||||
|
|
||||||
viper.ReadConfig(bytes.NewBuffer(yamlExample))
|
|
||||||
|
|
||||||
viper.Get("name") // this would be "steve"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Setting Overrides
|
|
||||||
|
|
||||||
These could be from a command line flag, or from your own application logic.
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.Set("Verbose", true)
|
|
||||||
viper.Set("LogFile", LogFile)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Registering and Using Aliases
|
|
||||||
|
|
||||||
Aliases permit a single value to be referenced by multiple keys
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.RegisterAlias("loud", "Verbose")
|
|
||||||
|
|
||||||
viper.Set("verbose", true) // same result as next line
|
|
||||||
viper.Set("loud", true) // same result as prior line
|
|
||||||
|
|
||||||
viper.GetBool("loud") // true
|
|
||||||
viper.GetBool("verbose") // true
|
|
||||||
```
|
|
||||||
|
|
||||||
### Working with Environment Variables
|
|
||||||
|
|
||||||
Viper has full support for environment variables. This enables 12 factor
|
|
||||||
applications out of the box. There are four methods that exist to aid working
|
|
||||||
with ENV:
|
|
||||||
|
|
||||||
* `AutomaticEnv()`
|
|
||||||
* `BindEnv(string...) : error`
|
|
||||||
* `SetEnvPrefix(string)`
|
|
||||||
* `SetEnvKeyReplacer(string...) *strings.Replacer`
|
|
||||||
|
|
||||||
_When working with ENV variables, it’s important to recognize that Viper
|
|
||||||
treats ENV variables as case sensitive._
|
|
||||||
|
|
||||||
Viper provides a mechanism to try to ensure that ENV variables are unique. By
|
|
||||||
using `SetEnvPrefix`, you can tell Viper to use add a prefix while reading from
|
|
||||||
the environment variables. Both `BindEnv` and `AutomaticEnv` will use this
|
|
||||||
prefix.
|
|
||||||
|
|
||||||
`BindEnv` takes one or two parameters. The first parameter is the key name, the
|
|
||||||
second is the name of the environment variable. The name of the environment
|
|
||||||
variable is case sensitive. If the ENV variable name is not provided, then
|
|
||||||
Viper will automatically assume that the key name matches the ENV variable name,
|
|
||||||
but the ENV variable is IN ALL CAPS. When you explicitly provide the ENV
|
|
||||||
variable name, it **does not** automatically add the prefix.
|
|
||||||
|
|
||||||
One important thing to recognize when working with ENV variables is that the
|
|
||||||
value will be read each time it is accessed. Viper does not fix the value when
|
|
||||||
the `BindEnv` is called.
|
|
||||||
|
|
||||||
`AutomaticEnv` is a powerful helper especially when combined with
|
|
||||||
`SetEnvPrefix`. When called, Viper will check for an environment variable any
|
|
||||||
time a `viper.Get` request is made. It will apply the following rules. It will
|
|
||||||
check for a environment variable with a name matching the key uppercased and
|
|
||||||
prefixed with the `EnvPrefix` if set.
|
|
||||||
|
|
||||||
`SetEnvKeyReplacer` allows you to use a `strings.Replacer` object to rewrite Env
|
|
||||||
keys to an extent. This is useful if you want to use `-` or something in your
|
|
||||||
`Get()` calls, but want your environmental variables to use `_` delimiters. An
|
|
||||||
example of using it can be found in `viper_test.go`.
|
|
||||||
|
|
||||||
#### Env example
|
|
||||||
|
|
||||||
```go
|
|
||||||
SetEnvPrefix("spf") // will be uppercased automatically
|
|
||||||
BindEnv("id")
|
|
||||||
|
|
||||||
os.Setenv("SPF_ID", "13") // typically done outside of the app
|
|
||||||
|
|
||||||
id := Get("id") // 13
|
|
||||||
```
|
|
||||||
|
|
||||||
### Working with Flags
|
|
||||||
|
|
||||||
Viper has the ability to bind to flags. Specifically, Viper supports `Pflags`
|
|
||||||
as used in the [Cobra](https://github.com/spf13/cobra) library.
|
|
||||||
|
|
||||||
Like `BindEnv`, the value is not set when the binding method is called, but when
|
|
||||||
it is accessed. This means you can bind as early as you want, even in an
|
|
||||||
`init()` function.
|
|
||||||
|
|
||||||
For individual flags, the `BindPFlag()` method provides this functionality.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
|
|
||||||
viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also bind an existing set of pflags (pflag.FlagSet):
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
pflag.Int("flagname", 1234, "help message for flagname")
|
|
||||||
|
|
||||||
pflag.Parse()
|
|
||||||
viper.BindPFlags(pflag.CommandLine)
|
|
||||||
|
|
||||||
i := viper.GetInt("flagname") // retrieve values from viper instead of pflag
|
|
||||||
```
|
|
||||||
|
|
||||||
The use of [pflag](https://github.com/spf13/pflag/) in Viper does not preclude
|
|
||||||
the use of other packages that use the [flag](https://golang.org/pkg/flag/)
|
|
||||||
package from the standard library. The pflag package can handle the flags
|
|
||||||
defined for the flag package by importing these flags. This is accomplished
|
|
||||||
by a calling a convenience function provided by the pflag package called
|
|
||||||
AddGoFlagSet().
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"flag"
|
|
||||||
"github.com/spf13/pflag"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
|
|
||||||
// using standard library "flag" package
|
|
||||||
flag.Int("flagname", 1234, "help message for flagname")
|
|
||||||
|
|
||||||
pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
|
|
||||||
pflag.Parse()
|
|
||||||
viper.BindPFlags(pflag.CommandLine)
|
|
||||||
|
|
||||||
i := viper.GetInt("flagname") // retrieve value from viper
|
|
||||||
|
|
||||||
...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Flag interfaces
|
|
||||||
|
|
||||||
Viper provides two Go interfaces to bind other flag systems if you don’t use `Pflags`.
|
|
||||||
|
|
||||||
`FlagValue` represents a single flag. This is a very simple example on how to implement this interface:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type myFlag struct {}
|
|
||||||
func (f myFlag) HasChanged() bool { return false }
|
|
||||||
func (f myFlag) Name() string { return "my-flag-name" }
|
|
||||||
func (f myFlag) ValueString() string { return "my-flag-value" }
|
|
||||||
func (f myFlag) ValueType() string { return "string" }
|
|
||||||
```
|
|
||||||
|
|
||||||
Once your flag implements this interface, you can simply tell Viper to bind it:
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.BindFlagValue("my-flag-name", myFlag{})
|
|
||||||
```
|
|
||||||
|
|
||||||
`FlagValueSet` represents a group of flags. This is a very simple example on how to implement this interface:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type myFlagSet struct {
|
|
||||||
flags []myFlag
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f myFlagSet) VisitAll(fn func(FlagValue)) {
|
|
||||||
for _, flag := range flags {
|
|
||||||
fn(flag)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Once your flag set implements this interface, you can simply tell Viper to bind it:
|
|
||||||
|
|
||||||
```go
|
|
||||||
fSet := myFlagSet{
|
|
||||||
flags: []myFlag{myFlag{}, myFlag{}},
|
|
||||||
}
|
|
||||||
viper.BindFlagValues("my-flags", fSet)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Remote Key/Value Store Support
|
|
||||||
|
|
||||||
To enable remote support in Viper, do a blank import of the `viper/remote`
|
|
||||||
package:
|
|
||||||
|
|
||||||
`import _ "github.com/spf13/viper/remote"`
|
|
||||||
|
|
||||||
Viper will read a config string (as JSON, TOML, YAML or HCL) retrieved from a path
|
|
||||||
in a Key/Value store such as etcd or Consul. These values take precedence over
|
|
||||||
default values, but are overridden by configuration values retrieved from disk,
|
|
||||||
flags, or environment variables.
|
|
||||||
|
|
||||||
Viper uses [crypt](https://github.com/xordataexchange/crypt) to retrieve
|
|
||||||
configuration from the K/V store, which means that you can store your
|
|
||||||
configuration values encrypted and have them automatically decrypted if you have
|
|
||||||
the correct gpg keyring. Encryption is optional.
|
|
||||||
|
|
||||||
You can use remote configuration in conjunction with local configuration, or
|
|
||||||
independently of it.
|
|
||||||
|
|
||||||
`crypt` has a command-line helper that you can use to put configurations in your
|
|
||||||
K/V store. `crypt` defaults to etcd on http://127.0.0.1:4001.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ go get github.com/xordataexchange/crypt/bin/crypt
|
|
||||||
$ crypt set -plaintext /config/hugo.json /Users/hugo/settings/config.json
|
|
||||||
```
|
|
||||||
|
|
||||||
Confirm that your value was set:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ crypt get -plaintext /config/hugo.json
|
|
||||||
```
|
|
||||||
|
|
||||||
See the `crypt` documentation for examples of how to set encrypted values, or
|
|
||||||
how to use Consul.
|
|
||||||
|
|
||||||
### Remote Key/Value Store Example - Unencrypted
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001","/config/hugo.json")
|
|
||||||
viper.SetConfigType("json") // because there is no file extension in a stream of bytes, supported extensions are "json", "toml", "yaml", "yml", "properties", "props", "prop"
|
|
||||||
err := viper.ReadRemoteConfig()
|
|
||||||
```
|
|
||||||
|
|
||||||
### Remote Key/Value Store Example - Encrypted
|
|
||||||
|
|
||||||
```go
|
|
||||||
viper.AddSecureRemoteProvider("etcd","http://127.0.0.1:4001","/config/hugo.json","/etc/secrets/mykeyring.gpg")
|
|
||||||
viper.SetConfigType("json") // because there is no file extension in a stream of bytes, supported extensions are "json", "toml", "yaml", "yml", "properties", "props", "prop"
|
|
||||||
err := viper.ReadRemoteConfig()
|
|
||||||
```
|
|
||||||
|
|
||||||
### Watching Changes in etcd - Unencrypted
|
|
||||||
|
|
||||||
```go
|
|
||||||
// alternatively, you can create a new viper instance.
|
|
||||||
var runtime_viper = viper.New()
|
|
||||||
|
|
||||||
runtime_viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001", "/config/hugo.yml")
|
|
||||||
runtime_viper.SetConfigType("yaml") // because there is no file extension in a stream of bytes, supported extensions are "json", "toml", "yaml", "yml", "properties", "props", "prop"
|
|
||||||
|
|
||||||
// read from remote config the first time.
|
|
||||||
err := runtime_viper.ReadRemoteConfig()
|
|
||||||
|
|
||||||
// unmarshal config
|
|
||||||
runtime_viper.Unmarshal(&runtime_conf)
|
|
||||||
|
|
||||||
// open a goroutine to watch remote changes forever
|
|
||||||
go func(){
|
|
||||||
for {
|
|
||||||
time.Sleep(time.Second * 5) // delay after each request
|
|
||||||
|
|
||||||
// currently, only tested with etcd support
|
|
||||||
err := runtime_viper.WatchRemoteConfig()
|
|
||||||
if err != nil {
|
|
||||||
log.Errorf("unable to read remote config: %v", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// unmarshal new config into our runtime config struct. you can also use channel
|
|
||||||
// to implement a signal to notify the system of the changes
|
|
||||||
runtime_viper.Unmarshal(&runtime_conf)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
```
|
|
||||||
|
|
||||||
## Getting Values From Viper
|
|
||||||
|
|
||||||
In Viper, there are a few ways to get a value depending on the value’s type.
|
|
||||||
The following functions and methods exist:
|
|
||||||
|
|
||||||
* `Get(key string) : interface{}`
|
|
||||||
* `GetBool(key string) : bool`
|
|
||||||
* `GetFloat64(key string) : float64`
|
|
||||||
* `GetInt(key string) : int`
|
|
||||||
* `GetString(key string) : string`
|
|
||||||
* `GetStringMap(key string) : map[string]interface{}`
|
|
||||||
* `GetStringMapString(key string) : map[string]string`
|
|
||||||
* `GetStringSlice(key string) : []string`
|
|
||||||
* `GetTime(key string) : time.Time`
|
|
||||||
* `GetDuration(key string) : time.Duration`
|
|
||||||
* `IsSet(key string) : bool`
|
|
||||||
|
|
||||||
One important thing to recognize is that each Get function will return a zero
|
|
||||||
value if it’s not found. To check if a given key exists, the `IsSet()` method
|
|
||||||
has been provided.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```go
|
|
||||||
viper.GetString("logfile") // case-insensitive Setting & Getting
|
|
||||||
if viper.GetBool("verbose") {
|
|
||||||
fmt.Println("verbose enabled")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
### Accessing nested keys
|
|
||||||
|
|
||||||
The accessor methods also accept formatted paths to deeply nested keys. For
|
|
||||||
example, if the following JSON file is loaded:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"host": {
|
|
||||||
"address": "localhost",
|
|
||||||
"port": 5799
|
|
||||||
},
|
|
||||||
"datastore": {
|
|
||||||
"metric": {
|
|
||||||
"host": "127.0.0.1",
|
|
||||||
"port": 3099
|
|
||||||
},
|
|
||||||
"warehouse": {
|
|
||||||
"host": "198.0.0.1",
|
|
||||||
"port": 2112
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Viper can access a nested field by passing a `.` delimited path of keys:
|
|
||||||
|
|
||||||
```go
|
|
||||||
GetString("datastore.metric.host") // (returns "127.0.0.1")
|
|
||||||
```
|
|
||||||
|
|
||||||
This obeys the precedence rules established above; the search for the path
|
|
||||||
will cascade through the remaining configuration registries until found.
|
|
||||||
|
|
||||||
For example, given this configuration file, both `datastore.metric.host` and
|
|
||||||
`datastore.metric.port` are already defined (and may be overridden). If in addition
|
|
||||||
`datastore.metric.protocol` was defined in the defaults, Viper would also find it.
|
|
||||||
|
|
||||||
However, if `datastore.metric` was overridden (by a flag, an environment variable,
|
|
||||||
the `Set()` method, …) with an immediate value, then all sub-keys of
|
|
||||||
`datastore.metric` become undefined, they are “shadowed” by the higher-priority
|
|
||||||
configuration level.
|
|
||||||
|
|
||||||
Lastly, if there exists a key that matches the delimited key path, its value
|
|
||||||
will be returned instead. E.g.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"datastore.metric.host": "0.0.0.0",
|
|
||||||
"host": {
|
|
||||||
"address": "localhost",
|
|
||||||
"port": 5799
|
|
||||||
},
|
|
||||||
"datastore": {
|
|
||||||
"metric": {
|
|
||||||
"host": "127.0.0.1",
|
|
||||||
"port": 3099
|
|
||||||
},
|
|
||||||
"warehouse": {
|
|
||||||
"host": "198.0.0.1",
|
|
||||||
"port": 2112
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
GetString("datastore.metric.host") // returns "0.0.0.0"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Extract sub-tree
|
|
||||||
|
|
||||||
Extract sub-tree from Viper.
|
|
||||||
|
|
||||||
For example, `viper` represents:
|
|
||||||
|
|
||||||
```json
|
|
||||||
app:
|
|
||||||
cache1:
|
|
||||||
max-items: 100
|
|
||||||
item-size: 64
|
|
||||||
cache2:
|
|
||||||
max-items: 200
|
|
||||||
item-size: 80
|
|
||||||
```
|
|
||||||
|
|
||||||
After executing:
|
|
||||||
|
|
||||||
```go
|
|
||||||
subv := viper.Sub("app.cache1")
|
|
||||||
```
|
|
||||||
|
|
||||||
`subv` represents:
|
|
||||||
|
|
||||||
```json
|
|
||||||
max-items: 100
|
|
||||||
item-size: 64
|
|
||||||
```
|
|
||||||
|
|
||||||
Suppose we have:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func NewCache(cfg *Viper) *Cache {...}
|
|
||||||
```
|
|
||||||
|
|
||||||
which creates a cache based on config information formatted as `subv`.
|
|
||||||
Now it’s easy to create these 2 caches separately as:
|
|
||||||
|
|
||||||
```go
|
|
||||||
cfg1 := viper.Sub("app.cache1")
|
|
||||||
cache1 := NewCache(cfg1)
|
|
||||||
|
|
||||||
cfg2 := viper.Sub("app.cache2")
|
|
||||||
cache2 := NewCache(cfg2)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Unmarshaling
|
|
||||||
|
|
||||||
You also have the option of Unmarshaling all or a specific value to a struct, map,
|
|
||||||
etc.
|
|
||||||
|
|
||||||
There are two methods to do this:
|
|
||||||
|
|
||||||
* `Unmarshal(rawVal interface{}) : error`
|
|
||||||
* `UnmarshalKey(key string, rawVal interface{}) : error`
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type config struct {
|
|
||||||
Port int
|
|
||||||
Name string
|
|
||||||
PathMap string `mapstructure:"path_map"`
|
|
||||||
}
|
|
||||||
|
|
||||||
var C config
|
|
||||||
|
|
||||||
err := Unmarshal(&C)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unable to decode into struct, %v", err)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Viper or Vipers?
|
|
||||||
|
|
||||||
Viper comes ready to use out of the box. There is no configuration or
|
|
||||||
initialization needed to begin using Viper. Since most applications will want
|
|
||||||
to use a single central repository for their configuration, the viper package
|
|
||||||
provides this. It is similar to a singleton.
|
|
||||||
|
|
||||||
In all of the examples above, they demonstrate using viper in its singleton
|
|
||||||
style approach.
|
|
||||||
|
|
||||||
### Working with multiple vipers
|
|
||||||
|
|
||||||
You can also create many different vipers for use in your application. Each will
|
|
||||||
have its own unique set of configurations and values. Each can read from a
|
|
||||||
different config file, key value store, etc. All of the functions that viper
|
|
||||||
package supports are mirrored as methods on a viper.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
x := viper.New()
|
|
||||||
y := viper.New()
|
|
||||||
|
|
||||||
x.SetDefault("ContentDir", "content")
|
|
||||||
y.SetDefault("ContentDir", "foobar")
|
|
||||||
|
|
||||||
//...
|
|
||||||
```
|
|
||||||
|
|
||||||
When working with multiple vipers, it is up to the user to keep track of the
|
|
||||||
different vipers.
|
|
||||||
|
|
||||||
## Q & A
|
|
||||||
|
|
||||||
Q: Why not INI files?
|
|
||||||
|
|
||||||
A: Ini files are pretty awful. There’s no standard format, and they are hard to
|
|
||||||
validate. Viper is designed to work with JSON, TOML or YAML files. If someone
|
|
||||||
really wants to add this feature, I’d be happy to merge it. It’s easy to specify
|
|
||||||
which formats your application will permit.
|
|
||||||
|
|
||||||
Q: Why is it called “Viper”?
|
|
||||||
|
|
||||||
A: Viper is designed to be a [companion](http://en.wikipedia.org/wiki/Viper_(G.I._Joe))
|
|
||||||
to [Cobra](https://github.com/spf13/cobra). While both can operate completely
|
|
||||||
independently, together they make a powerful pair to handle much of your
|
|
||||||
application foundation needs.
|
|
||||||
|
|
||||||
Q: Why is it called “Cobra”?
|
|
||||||
|
|
||||||
A: Is there a better name for a [commander](http://en.wikipedia.org/wiki/Cobra_Commander)?
|
|
2
vendor/golang.org/x/net/http2/.gitignore
generated
vendored
2
vendor/golang.org/x/net/http2/.gitignore
generated
vendored
|
@ -1,2 +0,0 @@
|
||||||
*~
|
|
||||||
h2i/h2i
|
|
51
vendor/golang.org/x/net/http2/Dockerfile
generated
vendored
51
vendor/golang.org/x/net/http2/Dockerfile
generated
vendored
|
@ -1,51 +0,0 @@
|
||||||
#
|
|
||||||
# This Dockerfile builds a recent curl with HTTP/2 client support, using
|
|
||||||
# a recent nghttp2 build.
|
|
||||||
#
|
|
||||||
# See the Makefile for how to tag it. If Docker and that image is found, the
|
|
||||||
# Go tests use this curl binary for integration tests.
|
|
||||||
#
|
|
||||||
|
|
||||||
FROM ubuntu:trusty
|
|
||||||
|
|
||||||
RUN apt-get update && \
|
|
||||||
apt-get upgrade -y && \
|
|
||||||
apt-get install -y git-core build-essential wget
|
|
||||||
|
|
||||||
RUN apt-get install -y --no-install-recommends \
|
|
||||||
autotools-dev libtool pkg-config zlib1g-dev \
|
|
||||||
libcunit1-dev libssl-dev libxml2-dev libevent-dev \
|
|
||||||
automake autoconf
|
|
||||||
|
|
||||||
# The list of packages nghttp2 recommends for h2load:
|
|
||||||
RUN apt-get install -y --no-install-recommends make binutils \
|
|
||||||
autoconf automake autotools-dev \
|
|
||||||
libtool pkg-config zlib1g-dev libcunit1-dev libssl-dev libxml2-dev \
|
|
||||||
libev-dev libevent-dev libjansson-dev libjemalloc-dev \
|
|
||||||
cython python3.4-dev python-setuptools
|
|
||||||
|
|
||||||
# Note: setting NGHTTP2_VER before the git clone, so an old git clone isn't cached:
|
|
||||||
ENV NGHTTP2_VER 895da9a
|
|
||||||
RUN cd /root && git clone https://github.com/tatsuhiro-t/nghttp2.git
|
|
||||||
|
|
||||||
WORKDIR /root/nghttp2
|
|
||||||
RUN git reset --hard $NGHTTP2_VER
|
|
||||||
RUN autoreconf -i
|
|
||||||
RUN automake
|
|
||||||
RUN autoconf
|
|
||||||
RUN ./configure
|
|
||||||
RUN make
|
|
||||||
RUN make install
|
|
||||||
|
|
||||||
WORKDIR /root
|
|
||||||
RUN wget http://curl.haxx.se/download/curl-7.45.0.tar.gz
|
|
||||||
RUN tar -zxvf curl-7.45.0.tar.gz
|
|
||||||
WORKDIR /root/curl-7.45.0
|
|
||||||
RUN ./configure --with-ssl --with-nghttp2=/usr/local
|
|
||||||
RUN make
|
|
||||||
RUN make install
|
|
||||||
RUN ldconfig
|
|
||||||
|
|
||||||
CMD ["-h"]
|
|
||||||
ENTRYPOINT ["/usr/local/bin/curl"]
|
|
||||||
|
|
3
vendor/golang.org/x/net/http2/Makefile
generated
vendored
3
vendor/golang.org/x/net/http2/Makefile
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
curlimage:
|
|
||||||
docker build -t gohttp2/curl .
|
|
||||||
|
|
20
vendor/golang.org/x/net/http2/README
generated
vendored
20
vendor/golang.org/x/net/http2/README
generated
vendored
|
@ -1,20 +0,0 @@
|
||||||
This is a work-in-progress HTTP/2 implementation for Go.
|
|
||||||
|
|
||||||
It will eventually live in the Go standard library and won't require
|
|
||||||
any changes to your code to use. It will just be automatic.
|
|
||||||
|
|
||||||
Status:
|
|
||||||
|
|
||||||
* The server support is pretty good. A few things are missing
|
|
||||||
but are being worked on.
|
|
||||||
* The client work has just started but shares a lot of code
|
|
||||||
is coming along much quicker.
|
|
||||||
|
|
||||||
Docs are at https://godoc.org/golang.org/x/net/http2
|
|
||||||
|
|
||||||
Demo test server at https://http2.golang.org/
|
|
||||||
|
|
||||||
Help & bug reports welcome!
|
|
||||||
|
|
||||||
Contributing: https://golang.org/doc/contribute.html
|
|
||||||
Bugs: https://golang.org/issue/new?title=x/net/http2:+
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue