fix(matrix): allow title to be passed as prop (#203)

- fix(matrix): allow room prop alias - test(matrix): add tests for url props
containrrr · Oct 9, 2021 · 2951098 · 2951098
1 parent b1a59a7
commit 2951098
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/docs/services/matrix.md b/docs/services/matrix.md
@@ -4,6 +4,8 @@
 
 *matrix://__`user`__:__`password`__@__`host`__:__`port`__/[?rooms=__`!roomID1`__[,__`roomAlias2`__]][&disableTLS=yes]*
 
+--8<-- "docs/services/matrix/config.md"
+
 ## Authentication
 
 If no `user` is specified, the `password` is treated as the authentication token. This means that no matter what login

diff --git a/pkg/services/matrix/matrix_config.go b/pkg/services/matrix/matrix_config.go
@@ -15,7 +15,8 @@ type Config struct {
 	Password   string
 	DisableTLS bool `key:"disableTLS" default:"No"`
 	Host       string
-	Rooms      []string `key:"rooms" optional:""`
+	Rooms      []string `key:"rooms,room" optional:""`
+	Title      string   `key:"title" default:""`
 }
 
 // GetURL returns a URL representation of it's current field values

diff --git a/pkg/services/matrix/matrix_test.go b/pkg/services/matrix/matrix_test.go
@@ -47,8 +47,26 @@ var _ = Describe("the matrix service", func() {
 	})
 
 	Describe("creating configurations", func() {
-		When("given an url", func() {
+		When("given an url with title prop", func() {
+			It("should not throw an error", func() {
+				serviceURL := util.URLMust(`matrix://user:pass@mockserver?rooms=room1&title=Better%20Off%20Alone`)
+				Expect((&Config{}).SetURL(serviceURL)).To(Succeed())
+			})
+		})
 
+		When("given an url with the prop `room`", func() {
+			It("should treat is as an alias for `rooms`", func() {
+				serviceURL := util.URLMust(`matrix://user:pass@mockserver?room=room1`)
+				config := Config{}
+				Expect(config.SetURL(serviceURL)).To(Succeed())
+				Expect(config.Rooms).To(ContainElement("#room1"))
+			})
+		})
+		When("given an url with invalid props", func() {
+			It("should return an error", func() {
+				serviceURL := util.URLMust(`matrix://user:pass@mockserver?channels=room1,room2`)
+				Expect((&Config{}).SetURL(serviceURL)).To(HaveOccurred())
+			})
 		})
 		When("parsing the configuration URL", func() {
 			It("should be identical after de-/serialization", func() {
@@ -130,7 +148,7 @@ var _ = Describe("the matrix service", func() {
 		testutils.TestConfigSetInvalidQueryValue(&Config{}, "matrix://user:pass@host/?foo=bar")
 
 		testutils.TestConfigGetEnumsCount(&Config{}, 0)
-		testutils.TestConfigGetFieldsCount(&Config{}, 2)
+		testutils.TestConfigGetFieldsCount(&Config{}, 4)
 	})
 })