From ec30d143cd39020370ca021bcbc50eac15bb91b5 Mon Sep 17 00:00:00 2001 From: Thibaut CHARLES Date: Tue, 19 Dec 2017 10:49:42 +0100 Subject: [PATCH 1/6] User registration return M_USER_IN_USE when username is already taken (#372) When registering a new user using POST `/_matrix/client/r0/register`, the server was returning a 500 error when user name was already taken. I added a check in `completeRegistration` to verify if the username is available before inserting it, and return a 400 `M_USER_IN_USE` error if there is a conflict, as [defined in matrix-doc](https://matrix.org/speculator/spec/HEAD/client_server/unstable.html#post-matrix-client-r0-register) Signed-off-by: Thibaut CHARLES cromfr@gmail.com --- .../dendrite/clientapi/auth/storage/accounts/storage.go | 6 +++++- .../matrix-org/dendrite/clientapi/jsonerror/jsonerror.go | 6 ++++++ .../matrix-org/dendrite/clientapi/routing/register.go | 5 +++++ .../matrix-org/dendrite/cmd/create-account/main.go | 5 ++++- src/github.com/matrix-org/dendrite/common/sql.go | 8 ++++++++ 5 files changed, 28 insertions(+), 2 deletions(-) diff --git a/src/github.com/matrix-org/dendrite/clientapi/auth/storage/accounts/storage.go b/src/github.com/matrix-org/dendrite/clientapi/auth/storage/accounts/storage.go index d5712eb50..e88942e34 100644 --- a/src/github.com/matrix-org/dendrite/clientapi/auth/storage/accounts/storage.go +++ b/src/github.com/matrix-org/dendrite/clientapi/auth/storage/accounts/storage.go @@ -118,7 +118,8 @@ func (d *Database) SetDisplayName( } // CreateAccount makes a new account with the given login name and password, and creates an empty profile -// for this account. If no password is supplied, the account will be a passwordless account. +// for this account. If no password is supplied, the account will be a passwordless account. If the +// account already exists, it will return nil, nil. func (d *Database) CreateAccount( ctx context.Context, localpart, plaintextPassword string, ) (*authtypes.Account, error) { @@ -127,6 +128,9 @@ func (d *Database) CreateAccount( return nil, err } if err := d.profiles.insertProfile(ctx, localpart); err != nil { + if common.IsUniqueConstraintViolationErr(err) { + return nil, nil + } return nil, err } return d.accounts.insertAccount(ctx, localpart, hash) diff --git a/src/github.com/matrix-org/dendrite/clientapi/jsonerror/jsonerror.go b/src/github.com/matrix-org/dendrite/clientapi/jsonerror/jsonerror.go index 07fe90304..1bab645fa 100644 --- a/src/github.com/matrix-org/dendrite/clientapi/jsonerror/jsonerror.go +++ b/src/github.com/matrix-org/dendrite/clientapi/jsonerror/jsonerror.go @@ -103,6 +103,12 @@ func InvalidUsername(msg string) *MatrixError { return &MatrixError{"M_INVALID_USERNAME", msg} } +// UserInUse is an error returned when the client tries to register an +// username that already exists +func UserInUse(msg string) *MatrixError { + return &MatrixError{"M_USER_IN_USE", msg} +} + // GuestAccessForbidden is an error which is returned when the client is // forbidden from accessing a resource as a guest. func GuestAccessForbidden(msg string) *MatrixError { diff --git a/src/github.com/matrix-org/dendrite/clientapi/routing/register.go b/src/github.com/matrix-org/dendrite/clientapi/routing/register.go index 7bd5820f9..3068f521d 100644 --- a/src/github.com/matrix-org/dendrite/clientapi/routing/register.go +++ b/src/github.com/matrix-org/dendrite/clientapi/routing/register.go @@ -463,6 +463,11 @@ func completeRegistration( Code: 500, JSON: jsonerror.Unknown("failed to create account: " + err.Error()), } + } else if acc == nil { + return util.JSONResponse{ + Code: 400, + JSON: jsonerror.UserInUse("Desired user ID is already taken."), + } } token, err := auth.GenerateAccessToken() diff --git a/src/github.com/matrix-org/dendrite/cmd/create-account/main.go b/src/github.com/matrix-org/dendrite/cmd/create-account/main.go index 7914a6266..99e9b545d 100644 --- a/src/github.com/matrix-org/dendrite/cmd/create-account/main.go +++ b/src/github.com/matrix-org/dendrite/cmd/create-account/main.go @@ -69,10 +69,13 @@ func main() { os.Exit(1) } - _, err = accountDB.CreateAccount(context.Background(), *username, *password) + account, err := accountDB.CreateAccount(context.Background(), *username, *password) if err != nil { fmt.Println(err.Error()) os.Exit(1) + } else if account == nil { + fmt.Println("Username already exists") + os.Exit(1) } deviceDB, err := devices.NewDatabase(*database, serverName) diff --git a/src/github.com/matrix-org/dendrite/common/sql.go b/src/github.com/matrix-org/dendrite/common/sql.go index f3de66f11..7ac9ac140 100644 --- a/src/github.com/matrix-org/dendrite/common/sql.go +++ b/src/github.com/matrix-org/dendrite/common/sql.go @@ -16,6 +16,8 @@ package common import ( "database/sql" + + "github.com/lib/pq" ) // A Transaction is something that can be committed or rolledback. @@ -66,3 +68,9 @@ func TxStmt(transaction *sql.Tx, statement *sql.Stmt) *sql.Stmt { } return statement } + +// IsUniqueConstraintViolationErr returns true if the error is a postgresql unique_violation error +func IsUniqueConstraintViolationErr(err error) bool { + pqErr, ok := err.(*pq.Error) + return ok && pqErr.Code == "23505" +} From 899f267c479d9d3c8e36552f8a5a8bad3afc7b24 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 19 Dec 2017 11:29:49 +0000 Subject: [PATCH 2/6] Fix roomserver deadlock (#380) Move the mutex lock outside the loop so that we don't lock up if there is more than one event --- .../matrix-org/dendrite/roomserver/input/input.go | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/github.com/matrix-org/dendrite/roomserver/input/input.go b/src/github.com/matrix-org/dendrite/roomserver/input/input.go index 4d5ba5cb1..4d5848f4c 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/input/input.go +++ b/src/github.com/matrix-org/dendrite/roomserver/input/input.go @@ -61,11 +61,10 @@ func (r *RoomserverInputAPI) InputRoomEvents( request *api.InputRoomEventsRequest, response *api.InputRoomEventsResponse, ) error { + // We lock as processRoomEvent can only be called once at a time + r.mutex.Lock() + defer r.mutex.Unlock() for i := range request.InputRoomEvents { - // We lock as processRoomEvent can ony be called once at a time - r.mutex.Lock() - defer r.mutex.Unlock() - if err := processRoomEvent(ctx, r.DB, r, request.InputRoomEvents[i]); err != nil { return err } From 0c26735bbdd5bcce3bf0bb9e5575a77fce08cc30 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 19 Dec 2017 13:45:14 +0000 Subject: [PATCH 3/6] console folding for travis (#381) Make the travis output a little more legible with some folding. --- scripts/travis-test.sh | 48 +++++++++++++++++++++++++++++++++++------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/scripts/travis-test.sh b/scripts/travis-test.sh index ace9a6c0e..5e32ed35a 100755 --- a/scripts/travis-test.sh +++ b/scripts/travis-test.sh @@ -15,6 +15,31 @@ export DENDRITE_LINT_DISABLE_GC=1 export GOPATH="$(pwd):$(pwd)/vendor" export PATH="$PATH:$(pwd)/bin" +# starts a travis fold section. The first argument is the name of the fold +# section (which appears on the RHS) and may contain no spaces. Remaining +# arguments are echoed in yellow on the LHS as the header line of the fold +# section. +travis_sections=() +function travis_start { + name="$1" + shift + echo -en "travis_fold:start:$name\r" + travis_sections+=($name) + + # yellow/bold + echo -en "\e[33;1m" + echo "$@" + # normal + echo -en "\e[0m" +} + +# ends a travis fold section +function travis_end { + name=${travis_sections[-1]} + unset 'travis_sections[-1]' + echo -en "travis_fold:end:$name\r" +} + if [ "${TEST_SUITE:-lint}" == "lint" ]; then ./scripts/find-lint.sh fi @@ -24,8 +49,10 @@ if [ "${TEST_SUITE:-unit-test}" == "unit-test" ]; then fi if [ "${TEST_SUITE:-integ-test}" == "integ-test" ]; then + travis_start gb-build "Building dendrite and integ tests" gb build - + travis_end + # Check that all the packages can build. # When `go build` is given multiple packages it won't output anything, and just # checks that everything builds. This seems to do a better job of handling @@ -43,13 +70,18 @@ if [ "${TEST_SUITE:-integ-test}" == "integ-test" ]; then gb build github.com/matrix-org/dendrite/cmd/client-api-proxy # Create necessary certificates and keys to run dendrite - echo "Generating certs..." - time openssl req -x509 -newkey rsa:512 -keyout server.key -out server.crt -days 365 -nodes -subj /CN=localhost - echo "Installing kafka..." - time ./scripts/install-local-kafka.sh + travis_start certs "Building SSL certs" + openssl req -x509 -newkey rsa:512 -keyout server.key -out server.crt -days 365 -nodes -subj /CN=localhost + travis_end + + travis_start kafka "Installing kafka" + ./scripts/install-local-kafka.sh + travis_end # Run the integration tests - bin/roomserver-integration-tests - bin/syncserver-integration-tests - bin/mediaapi-integration-tests + for i in roomserver syncserver mediaapi; do + travis_start "$i-integration-tests" "Running integration tests for $i" + bin/$i-integration-tests + travis_end + done fi From b64f8b5912ed48112ae8e7897aed76ea2d4f27fe Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 19 Dec 2017 13:56:41 +0000 Subject: [PATCH 4/6] kill kafka after integ tests (#383) If kafka is still running when our test script exits, travis gets stuck. --- scripts/travis-test.sh | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/scripts/travis-test.sh b/scripts/travis-test.sh index 5e32ed35a..2d0332153 100755 --- a/scripts/travis-test.sh +++ b/scripts/travis-test.sh @@ -40,6 +40,12 @@ function travis_end { echo -en "travis_fold:end:$name\r" } +function kill_kafka { + echo "killing kafka" + # sometimes kafka doesn't die on a SIGTERM so we SIGKILL it. + killall -9 -v java +} + if [ "${TEST_SUITE:-lint}" == "lint" ]; then ./scripts/find-lint.sh fi @@ -78,6 +84,11 @@ if [ "${TEST_SUITE:-integ-test}" == "integ-test" ]; then ./scripts/install-local-kafka.sh travis_end + # make sure we kill off zookeeper/kafka on exit, because it stops the + # travis container being cleaned up (cf + # https://github.com/travis-ci/travis-ci/issues/8082) + trap kill_kafka EXIT + # Run the integration tests for i in roomserver syncserver mediaapi; do travis_start "$i-integration-tests" "Running integration tests for $i" From 7e2362cd2eb5081f449fff90f52efe02d676d5d7 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 19 Dec 2017 14:09:15 +0000 Subject: [PATCH 5/6] Make travis builds a bit faster (#382) * travis: clone depth=1 * cache kafka download --- .gitignore | 2 +- .travis.yml | 7 +++++++ scripts/install-local-kafka.sh | 8 ++++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 50c7d7727..29d28271a 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,7 @@ .* # Downloads -kafka.tgz +/.downloads # Compiled Object files, Static and Dynamic libs (Shared Objects) *.o diff --git a/.travis.yml b/.travis.yml index b94e4e0f3..b65391d99 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,9 +19,16 @@ addons: services: - postgresql +cache: + directories: + - .downloads + install: - go get github.com/constabulary/gb/... script: - ./scripts/travis-test.sh +# we only need the latest git commit +git: + depth: 1 diff --git a/scripts/install-local-kafka.sh b/scripts/install-local-kafka.sh index 41bc7bd20..d1fef38e1 100755 --- a/scripts/install-local-kafka.sh +++ b/scripts/install-local-kafka.sh @@ -4,15 +4,19 @@ set -eu +cd `dirname $0`/.. + +mkdir -p .downloads + # The mirror to download kafka from is picked from the list of mirrors at # https://www.apache.org/dyn/closer.cgi?path=/kafka/0.10.2.0/kafka_2.11-0.11.0.2.tgz # TODO: Check the signature since we are downloading over HTTP. MIRROR=http://apache.mirror.anlx.net/kafka/0.11.0.2/kafka_2.11-0.11.0.2.tgz # Only download the kafka if it isn't already downloaded. -test -f kafka.tgz || wget $MIRROR -O kafka.tgz +test -f .downloads/kafka.tgz || wget $MIRROR -O .downloads/kafka.tgz # Unpack the kafka over the top of any existing installation -mkdir -p kafka && tar xzf kafka.tgz -C kafka --strip-components 1 +mkdir -p kafka && tar xzf .downloads/kafka.tgz -C kafka --strip-components 1 # Start the zookeeper running in the background. # By default the zookeeper listens on localhost:2181 kafka/bin/zookeeper-server-start.sh -daemon kafka/config/zookeeper.properties From fa362ecef2f71419d3819a763313167c42da9443 Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Tue, 19 Dec 2017 09:00:44 -0800 Subject: [PATCH 6/6] Load Application Service Configuration Files (#377) Signed-off-by: Andrew Morgan (https://amorgan.xyz) --- dendrite-config.yaml | 4 + .../dendrite/common/config/appservice.go | 79 +++++++ .../dendrite/common/config/config.go | 34 ++- vendor/manifest | 2 +- vendor/src/gopkg.in/yaml.v2/LICENSE | 208 +++++++++++++++++- vendor/src/gopkg.in/yaml.v2/README.md | 2 + vendor/src/gopkg.in/yaml.v2/decode.go | 10 +- vendor/src/gopkg.in/yaml.v2/decode_test.go | 36 ++- vendor/src/gopkg.in/yaml.v2/emitterc.go | 9 +- .../gopkg.in/yaml.v2/example_embedded_test.go | 41 ++++ vendor/src/gopkg.in/yaml.v2/parserc.go | 1 - vendor/src/gopkg.in/yaml.v2/scannerc.go | 9 +- vendor/src/gopkg.in/yaml.v2/yaml.go | 15 +- vendor/src/gopkg.in/yaml.v2/yamlh.go | 2 +- 14 files changed, 417 insertions(+), 35 deletions(-) create mode 100644 src/github.com/matrix-org/dendrite/common/config/appservice.go create mode 100644 vendor/src/gopkg.in/yaml.v2/example_embedded_test.go diff --git a/dendrite-config.yaml b/dendrite-config.yaml index 6e2326595..7c7b9bf05 100644 --- a/dendrite-config.yaml +++ b/dendrite-config.yaml @@ -120,3 +120,7 @@ tracing: # for documtation. jaeger: disabled: true + +# A list of application service config files to use +application_services: + config_files: [] diff --git a/src/github.com/matrix-org/dendrite/common/config/appservice.go b/src/github.com/matrix-org/dendrite/common/config/appservice.go new file mode 100644 index 000000000..3dc3cd662 --- /dev/null +++ b/src/github.com/matrix-org/dendrite/common/config/appservice.go @@ -0,0 +1,79 @@ +// Copyright 2017 Andrew Morgan +// +// 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. + +package config + +import ( + "io/ioutil" + "path/filepath" + + "gopkg.in/yaml.v2" +) + +// ApplicationServiceNamespace is the namespace that a specific application +// service has management over. +type ApplicationServiceNamespace struct { + // Whether or not the namespace is managed solely by this application service + Exclusive bool `yaml:"exclusive"` + // A regex pattern that represents the namespace + Regex string `yaml:"regex"` +} + +// ApplicationService represents a Matrix application service. +// https://matrix.org/docs/spec/application_service/unstable.html +type ApplicationService struct { + // User-defined, unique, persistent ID of the application service + ID string `yaml:"id"` + // Base URL of the application service + URL string `yaml:"url"` + // Application service token provided in requests to a homeserver + ASToken string `yaml:"as_token"` + // Homeserver token provided in requests to an application service + HSToken string `yaml:"hs_token"` + // Localpart of application service user + SenderLocalpart string `yaml:"sender_localpart"` + // Information about an application service's namespaces + Namespaces map[string][]ApplicationServiceNamespace `yaml:"namespaces"` +} + +func loadAppservices(config *Dendrite) error { + // Iterate through and return all the Application Services + for _, configPath := range config.ApplicationServices.ConfigFiles { + // Create a new application service + var appservice ApplicationService + + // Create an absolute path from a potentially relative path + absPath, err := filepath.Abs(configPath) + if err != nil { + return err + } + + // Read the application service's config file + configData, err := ioutil.ReadFile(absPath) + if err != nil { + return err + } + + // Load the config data into our struct + if err = yaml.UnmarshalStrict(configData, &appservice); err != nil { + return err + } + + // Append the parsed application service to the global config + config.Derived.ApplicationServices = append( + config.Derived.ApplicationServices, appservice) + } + + return nil +} diff --git a/src/github.com/matrix-org/dendrite/common/config/config.go b/src/github.com/matrix-org/dendrite/common/config/config.go index f291a076d..7a7f2b48d 100644 --- a/src/github.com/matrix-org/dendrite/common/config/config.go +++ b/src/github.com/matrix-org/dendrite/common/config/config.go @@ -186,7 +186,7 @@ type Dendrite struct { // Hardcoded Username and Password Username string `yaml:"turn_username"` Password string `yaml:"turn_password"` - } + } `yaml:"turn"` // The internal addresses the components will listen on. // These should not be exposed externally as they expose metrics and debugging APIs. @@ -204,7 +204,14 @@ type Dendrite struct { Tracing struct { // The config for the jaeger opentracing reporter. Jaeger jaegerconfig.Configuration `yaml:"jaeger"` - } + } `yaml:"tracing"` + + // Application Services + // https://matrix.org/docs/spec/application_service/unstable.html + ApplicationServices struct { + // Configuration files for various application services + ConfigFiles []string `yaml:"config_files"` + } `yaml:"application_services"` // Any information derived from the configuration options for later use. Derived struct { @@ -219,7 +226,11 @@ type Dendrite struct { // registration in order to complete registration stages. Params map[string]interface{} `json:"params"` } - } + + // Application Services parsed from their config files + // The paths of which were given above in the main config file + ApplicationServices []ApplicationService + } `yaml:"-"` } // A Path on the filesystem. @@ -323,7 +334,8 @@ func loadConfig( for _, certPath := range config.Matrix.FederationCertificatePaths { absCertPath := absPath(basePath, certPath) - pemData, err := readFile(absCertPath) + var pemData []byte + pemData, err = readFile(absCertPath) if err != nil { return nil, err } @@ -337,14 +349,17 @@ func loadConfig( config.Media.AbsBasePath = Path(absPath(basePath, config.Media.BasePath)) // Generate data from config options - config.derive() + err = config.derive() + if err != nil { + return nil, err + } return &config, nil } // derive generates data that is derived from various values provided in // the config file. -func (config *Dendrite) derive() { +func (config *Dendrite) derive() error { // Determine registrations flows based off config values config.Derived.Registration.Params = make(map[string]interface{}) @@ -360,6 +375,13 @@ func (config *Dendrite) derive() { config.Derived.Registration.Flows = append(config.Derived.Registration.Flows, authtypes.Flow{Stages: []authtypes.LoginType{authtypes.LoginTypeDummy}}) } + + // Load application service configuration files + if err := loadAppservices(config); err != nil { + return err + } + + return nil } // setDefaults sets default config values if they are not explicitly set. diff --git a/vendor/manifest b/vendor/manifest index 645998df0..c17b5cf8e 100644 --- a/vendor/manifest +++ b/vendor/manifest @@ -458,7 +458,7 @@ { "importpath": "gopkg.in/yaml.v2", "repository": "https://gopkg.in/yaml.v2", - "revision": "a3f3340b5840cee44f372bddb5880fcbc419b46a", + "revision": "287cf08546ab5e7e37d55a84f7ed3fd1db036de5", "branch": "v2" } ] diff --git a/vendor/src/gopkg.in/yaml.v2/LICENSE b/vendor/src/gopkg.in/yaml.v2/LICENSE index 866d74a7a..8dada3eda 100644 --- a/vendor/src/gopkg.in/yaml.v2/LICENSE +++ b/vendor/src/gopkg.in/yaml.v2/LICENSE @@ -1,13 +1,201 @@ -Copyright 2011-2016 Canonical Ltd. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -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 + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - http://www.apache.org/licenses/LICENSE-2.0 + 1. Definitions. -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. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. diff --git a/vendor/src/gopkg.in/yaml.v2/README.md b/vendor/src/gopkg.in/yaml.v2/README.md index 1884de6a7..7a512d67c 100644 --- a/vendor/src/gopkg.in/yaml.v2/README.md +++ b/vendor/src/gopkg.in/yaml.v2/README.md @@ -48,6 +48,8 @@ The yaml package is licensed under the Apache License 2.0. Please see the LICENS Example ------- +Some more examples can be found in the "examples" folder. + ```Go package main diff --git a/vendor/src/gopkg.in/yaml.v2/decode.go b/vendor/src/gopkg.in/yaml.v2/decode.go index b13ab9f07..b38e6ecf7 100644 --- a/vendor/src/gopkg.in/yaml.v2/decode.go +++ b/vendor/src/gopkg.in/yaml.v2/decode.go @@ -120,7 +120,6 @@ func (p *parser) parse() *node { default: panic("attempted to parse unknown event: " + strconv.Itoa(int(p.event.typ))) } - panic("unreachable") } func (p *parser) node(kind int) *node { @@ -191,6 +190,7 @@ type decoder struct { aliases map[string]bool mapType reflect.Type terrors []string + strict bool } var ( @@ -200,8 +200,8 @@ var ( ifaceType = defaultMapType.Elem() ) -func newDecoder() *decoder { - d := &decoder{mapType: defaultMapType} +func newDecoder(strict bool) *decoder { + d := &decoder{mapType: defaultMapType, strict: strict} d.aliases = make(map[string]bool) return d } @@ -251,7 +251,7 @@ func (d *decoder) callUnmarshaler(n *node, u Unmarshaler) (good bool) { // // If n holds a null value, prepare returns before doing anything. func (d *decoder) prepare(n *node, out reflect.Value) (newout reflect.Value, unmarshaled, good bool) { - if n.tag == yaml_NULL_TAG || n.kind == scalarNode && n.tag == "" && (n.value == "null" || n.value == "" && n.implicit) { + if n.tag == yaml_NULL_TAG || n.kind == scalarNode && n.tag == "" && (n.value == "null" || n.value == "~" || n.value == "" && n.implicit) { return out, false, false } again := true @@ -640,6 +640,8 @@ func (d *decoder) mappingStruct(n *node, out reflect.Value) (good bool) { value := reflect.New(elemType).Elem() d.unmarshal(n.children[i+1], value) inlineMap.SetMapIndex(name, value) + } else if d.strict { + d.terrors = append(d.terrors, fmt.Sprintf("line %d: field %s not found in struct %s", n.line+1, name.String(), out.Type())) } } return true diff --git a/vendor/src/gopkg.in/yaml.v2/decode_test.go b/vendor/src/gopkg.in/yaml.v2/decode_test.go index a6fea0f20..770c716bd 100644 --- a/vendor/src/gopkg.in/yaml.v2/decode_test.go +++ b/vendor/src/gopkg.in/yaml.v2/decode_test.go @@ -405,6 +405,12 @@ var unmarshalTests = []struct { map[string]interface{}{"v": 1}, }, + // Non-specific tag (Issue #75) + { + "v: ! test", + map[string]interface{}{"v": "test"}, + }, + // Anchors and aliases. { "a: &x 1\nb: &y 2\nc: *x\nd: *y\n", @@ -432,6 +438,9 @@ var unmarshalTests = []struct { { "foo: ''", map[string]*string{"foo": new(string)}, + }, { + "foo: null", + map[string]*string{"foo": nil}, }, { "foo: null", map[string]string{"foo": ""}, @@ -440,6 +449,18 @@ var unmarshalTests = []struct { map[string]interface{}{"foo": nil}, }, + // Support for ~ + { + "foo: ~", + map[string]*string{"foo": nil}, + }, { + "foo: ~", + map[string]string{"foo": ""}, + }, { + "foo: ~", + map[string]interface{}{"foo": nil}, + }, + // Ignored field { "a: 1\nb: 2\n", @@ -604,7 +625,8 @@ type inlineC struct { } func (s *S) TestUnmarshal(c *C) { - for _, item := range unmarshalTests { + for i, item := range unmarshalTests { + c.Logf("test %d: %q", i, item.data) t := reflect.ValueOf(item.value).Type() var value interface{} switch t.Kind() { @@ -648,6 +670,7 @@ var unmarshalErrorTests = []struct { {"a: !!binary ==", "yaml: !!binary value contains invalid base64 data"}, {"{[.]}", `yaml: invalid map key: \[\]interface \{\}\{"\."\}`}, {"{{.}}", `yaml: invalid map key: map\[interface\ \{\}\]interface \{\}\{".":interface \{\}\(nil\)\}`}, + {"%TAG !%79! tag:yaml.org,2002:\n---\nv: !%79!int '1'", "yaml: did not find expected whitespace"}, } func (s *S) TestUnmarshalErrors(c *C) { @@ -968,6 +991,17 @@ func (s *S) TestUnmarshalSliceOnPreset(c *C) { c.Assert(v.A, DeepEquals, []int{2}) } +func (s *S) TestUnmarshalStrict(c *C) { + v := struct{ A, B int }{} + + err := yaml.UnmarshalStrict([]byte("a: 1\nb: 2"), &v) + c.Check(err, IsNil) + err = yaml.Unmarshal([]byte("a: 1\nb: 2\nc: 3"), &v) + c.Check(err, IsNil) + err = yaml.UnmarshalStrict([]byte("a: 1\nb: 2\nc: 3"), &v) + c.Check(err, ErrorMatches, "yaml: unmarshal errors:\n line 1: field c not found in struct struct { A int; B int }") +} + //var data []byte //func init() { // var err error diff --git a/vendor/src/gopkg.in/yaml.v2/emitterc.go b/vendor/src/gopkg.in/yaml.v2/emitterc.go index 2befd553e..41de8b856 100644 --- a/vendor/src/gopkg.in/yaml.v2/emitterc.go +++ b/vendor/src/gopkg.in/yaml.v2/emitterc.go @@ -666,7 +666,6 @@ func yaml_emitter_emit_node(emitter *yaml_emitter_t, event *yaml_event_t, return yaml_emitter_set_emitter_error(emitter, "expected SCALAR, SEQUENCE-START, MAPPING-START, or ALIAS") } - return false } // Expect ALIAS. @@ -995,7 +994,7 @@ func yaml_emitter_analyze_scalar(emitter *yaml_emitter_t, value []byte) bool { break_space = false space_break = false - preceeded_by_whitespace = false + preceded_by_whitespace = false followed_by_whitespace = false previous_space = false previous_break = false @@ -1017,7 +1016,7 @@ func yaml_emitter_analyze_scalar(emitter *yaml_emitter_t, value []byte) bool { flow_indicators = true } - preceeded_by_whitespace = true + preceded_by_whitespace = true for i, w := 0, 0; i < len(value); i += w { w = width(value[i]) followed_by_whitespace = i+w >= len(value) || is_blank(value, i+w) @@ -1048,7 +1047,7 @@ func yaml_emitter_analyze_scalar(emitter *yaml_emitter_t, value []byte) bool { block_indicators = true } case '#': - if preceeded_by_whitespace { + if preceded_by_whitespace { flow_indicators = true block_indicators = true } @@ -1089,7 +1088,7 @@ func yaml_emitter_analyze_scalar(emitter *yaml_emitter_t, value []byte) bool { } // [Go]: Why 'z'? Couldn't be the end of the string as that's the loop condition. - preceeded_by_whitespace = is_blankz(value, i) + preceded_by_whitespace = is_blankz(value, i) } emitter.scalar_data.multiline = line_breaks diff --git a/vendor/src/gopkg.in/yaml.v2/example_embedded_test.go b/vendor/src/gopkg.in/yaml.v2/example_embedded_test.go new file mode 100644 index 000000000..c8b241d54 --- /dev/null +++ b/vendor/src/gopkg.in/yaml.v2/example_embedded_test.go @@ -0,0 +1,41 @@ +package yaml_test + +import ( + "fmt" + "log" + + "gopkg.in/yaml.v2" +) + +// An example showing how to unmarshal embedded +// structs from YAML. + +type StructA struct { + A string `yaml:"a"` +} + +type StructB struct { + // Embedded structs are not treated as embedded in YAML by default. To do that, + // add the ",inline" annotation below + StructA `yaml:",inline"` + B string `yaml:"b"` +} + +var data = ` +a: a string from struct A +b: a string from struct B +` + +func ExampleUnmarshal_embedded() { + var b StructB + + err := yaml.Unmarshal([]byte(data), &b) + if err != nil { + log.Fatal("cannot unmarshal data: %v", err) + } + fmt.Println(b.A) + fmt.Println(b.B) + // Output: + // a string from struct A + // a string from struct B +} diff --git a/vendor/src/gopkg.in/yaml.v2/parserc.go b/vendor/src/gopkg.in/yaml.v2/parserc.go index 0a7037ad1..81d05dfe5 100644 --- a/vendor/src/gopkg.in/yaml.v2/parserc.go +++ b/vendor/src/gopkg.in/yaml.v2/parserc.go @@ -166,7 +166,6 @@ func yaml_parser_state_machine(parser *yaml_parser_t, event *yaml_event_t) bool default: panic("invalid parser state") } - return false } // Parse the production: diff --git a/vendor/src/gopkg.in/yaml.v2/scannerc.go b/vendor/src/gopkg.in/yaml.v2/scannerc.go index 2c9d5111f..074484455 100644 --- a/vendor/src/gopkg.in/yaml.v2/scannerc.go +++ b/vendor/src/gopkg.in/yaml.v2/scannerc.go @@ -611,7 +611,7 @@ func yaml_parser_set_scanner_tag_error(parser *yaml_parser_t, directive bool, co if directive { context = "while parsing a %TAG directive" } - return yaml_parser_set_scanner_error(parser, context, context_mark, "did not find URI escaped octet") + return yaml_parser_set_scanner_error(parser, context, context_mark, problem) } func trace(args ...interface{}) func() { @@ -1944,7 +1944,7 @@ func yaml_parser_scan_tag_handle(parser *yaml_parser_t, directive bool, start_ma } else { // It's either the '!' tag or not really a tag handle. If it's a %TAG // directive, it's an error. If it's a tag token, it must be a part of URI. - if directive && !(s[0] == '!' && s[1] == 0) { + if directive && string(s) != "!" { yaml_parser_set_scanner_tag_error(parser, directive, start_mark, "did not find expected '!'") return false @@ -1959,6 +1959,7 @@ func yaml_parser_scan_tag_handle(parser *yaml_parser_t, directive bool, start_ma func yaml_parser_scan_tag_uri(parser *yaml_parser_t, directive bool, head []byte, start_mark yaml_mark_t, uri *[]byte) bool { //size_t length = head ? strlen((char *)head) : 0 var s []byte + hasTag := len(head) > 0 // Copy the head if needed. // @@ -2000,10 +2001,10 @@ func yaml_parser_scan_tag_uri(parser *yaml_parser_t, directive bool, head []byte if parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) { return false } + hasTag = true } - // Check if the tag is non-empty. - if len(s) == 0 { + if !hasTag { yaml_parser_set_scanner_tag_error(parser, directive, start_mark, "did not find expected tag URI") return false diff --git a/vendor/src/gopkg.in/yaml.v2/yaml.go b/vendor/src/gopkg.in/yaml.v2/yaml.go index 36d6b883a..5e3c2daee 100644 --- a/vendor/src/gopkg.in/yaml.v2/yaml.go +++ b/vendor/src/gopkg.in/yaml.v2/yaml.go @@ -77,8 +77,19 @@ type Marshaler interface { // supported tag options. // func Unmarshal(in []byte, out interface{}) (err error) { + return unmarshal(in, out, false) +} + +// UnmarshalStrict is like Unmarshal except that any fields that are found +// in the data that do not have corresponding struct members will result in +// an error. +func UnmarshalStrict(in []byte, out interface{}) (err error) { + return unmarshal(in, out, true) +} + +func unmarshal(in []byte, out interface{}, strict bool) (err error) { defer handleErr(&err) - d := newDecoder() + d := newDecoder(strict) p := newParser(in) defer p.destroy() node := p.parse() @@ -129,7 +140,7 @@ func Unmarshal(in []byte, out interface{}) (err error) { // For example: // // type T struct { -// F int "a,omitempty" +// F int `yaml:"a,omitempty"` // B int // } // yaml.Marshal(&T{B: 2}) // Returns "b: 2\n" diff --git a/vendor/src/gopkg.in/yaml.v2/yamlh.go b/vendor/src/gopkg.in/yaml.v2/yamlh.go index d60a6b6b0..3caeca049 100644 --- a/vendor/src/gopkg.in/yaml.v2/yamlh.go +++ b/vendor/src/gopkg.in/yaml.v2/yamlh.go @@ -508,7 +508,7 @@ type yaml_parser_t struct { problem string // Error description. - // The byte about which the problem occured. + // The byte about which the problem occurred. problem_offset int problem_value int problem_mark yaml_mark_t