#192 [LS] - Stardardize Mumble errors propagation to the GUI.

client/binary.go

@@ -18,7 +18,7 @@ var (
 	errInvalidBinaryFile          = errors.New("the defined binary file don't exists")
 	errBinaryAlreadyExists        = errors.New("the binary already exists in the destination directory")
 	errDestinationIsNotADirectory = errors.New("the destination to copy the binary is not a directory")
-	errNoClientInConfiguredPath   = errors.New("mumble binary not found in the configured path. Please ensure the path is correctly set and the binary is accessible.")
+	ErrNoClientInConfiguredPath   = errors.New("mumble binary not found in the configured path")
 )
 
 type binary struct {
@@ -190,7 +190,7 @@ func searchBinaryInConf(conf *config.ApplicationConfig) func() (*binary, error)
 
 		b := isThereAnAvailableBinary(configuredPath)
 		if b == nil || b.lastError != nil {
-			return nil, errNoClientInConfiguredPath
+			return nil, ErrNoClientInConfiguredPath
 		}
 
 		return b, nil

client/binary_test.go

@@ -395,7 +395,7 @@ func (s *clientSuite) Test_searchBinaryInConf_returnedCallbackFunctionReturnsAnE
 	binary, err := callBack()
 
 	c.Assert(binary, IsNil)
-	c.Assert(err, Equals, errNoClientInConfiguredPath)
+	c.Assert(err, Equals, ErrNoClientInConfiguredPath)
 }
 
 func (s *clientSuite) Test_searchBinaryInConf_returnsAValidFuncWhenANilConfIsProvided(c *C) {

client/client.go

@@ -70,7 +70,7 @@ type databaseProvider func() []byte
 // InitSystem do the checking of the current system looking
 // for the  appropriate Mumble binary and check for errors
 
-var errBinaryUnavailable = errors.New("a valid Mumble binary is not available on your system")
+var ErrBinaryUnavailable = errors.New("a valid Mumble binary is not available on your system")
 
 func InitSystem(conf *config.ApplicationConfig, tor tor.Instance) Instance {
 	i := newMumbleClient(readerMumbleIniConfig, readerMumbleJSONConfig, readerMumbleDB, tor)
@@ -81,7 +81,7 @@ func InitSystem(conf *config.ApplicationConfig, tor tor.Instance) Instance {
 	}
 
 	if b == nil {
-		return invalidInstance(errBinaryUnavailable)
+		return invalidInstance(ErrBinaryUnavailable)
 	}
 
 	if b.shouldBeCopied {

client/client_test.go

@@ -258,7 +258,7 @@ func (s *clientSuite) Test_InitSystem_returnsAnInvalidInstanceWhenAValidMumbleBi
 	client := i.(*client)
 
 	c.Assert(client.isValid, IsFalse)
-	c.Assert(client.err, Equals, errBinaryUnavailable)
+	c.Assert(client.err, Equals, ErrBinaryUnavailable)
 
 	ml.AssertExpectations(c)
 }

gui/locales/ar/out.gotext.json

@@ -197,19 +197,14 @@
             "fuzzy": true
         },
         {
-            "id": "Mumble client can't be used because:\n\n{Error}",
-            "message": "Mumble client can't be used because:\n\n{Error}",
-            "translation": "",
-            "placeholders": [
-                {
-                    "id": "Error",
-                    "string": "%[1]s",
-                    "type": "string",
-                    "underlyingType": "string",
-                    "argNum": 1,
-                    "expr": "err.Error()"
-                }
-            ]
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": ""
+        },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": ""
         },
         {
             "id": "please enter a valid password",

gui/locales/en/messages.gotext.json

@@ -243,23 +243,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "the Mumble client can not be used because: {Error}",
-            "message": "the Mumble client can not be used because: {Error}",
-            "translation": "The Mumble client can't be used because: {Error}",
-            "translatorComment": "Copied from source.",
-            "placeholders": [
-                {
-                    "id": "Error",
-                    "string": "%[1]s",
-                    "type": "string",
-                    "underlyingType": "string",
-                    "argNum": 1,
-                    "expr": "err.Error()"
-                }
-            ],
-            "fuzzy": true
-        },
         {
             "id": "please enter a valid password",
             "message": "please enter a valid password",
@@ -963,6 +946,16 @@
             "id": "No valid Tor binary found in the system in order to run Wahay.",
             "message": "No valid Tor binary found in the system in order to run Wahay.",
             "translation": "No valid Tor binary found in the system in order to run Wahay."
+        },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": "No valid Mumble binary found in the system in order to run Wahay."
+        },
+        {
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\n Please configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\n Please configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": "The configured path to the Mumble binary is not valid or can't be used.\n\n Please configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html"
         }
     ]
 }

gui/locales/en/out.gotext.json

@@ -207,22 +207,17 @@
             "fuzzy": true
         },
         {
-            "id": "Mumble client can't be used because:\n\n{Error}",
-            "message": "Mumble client can't be used because:\n\n{Error}",
-            "translation": "Mumble client can't be used because:\n\n{Error}",
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
             "translatorComment": "Copied from source.",
-            "placeholders": [
-                {
-                    "id": "Error",
-                    "string": "%[1]s",
-                    "type": "string",
-                    "underlyingType": "string",
-                    "argNum": 1,
-                    "expr": "err.Error()"
-                }
-            ],
             "fuzzy": true
         },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": "No valid Mumble binary found in the system in order to run Wahay."
+        },
         {
             "id": "please enter a valid password",
             "message": "please enter a valid password",

gui/locales/es/messages.gotext.json

@@ -955,6 +955,16 @@
             "id": "No valid Tor binary found in the system in order to run Wahay.",
             "message": "No valid Tor binary found in the system in order to run Wahay.",
             "translation": "No se encontró un binario de Tor válido en el sistema para ejecutar Wahay."
+        },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": "No se encontró un binario de Mumble válido en el sistema para ejecutar Wahay."
+        },
+        {
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\n Please configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\n Please configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": "La ruta configurada para el binario de Mumble no es válida o no se puede usar.\n\nPor favor, configura otra ruta o descarga un Wahay con Mumble incluido en el siguiente enlace:\n\nhttps://wahay.org/download.html"
         }
     ]
 }

gui/locales/es/out.gotext.json

@@ -197,19 +197,14 @@
             "fuzzy": true
         },
         {
-            "id": "Mumble client can't be used because:\n\n{Error}",
-            "message": "Mumble client can't be used because:\n\n{Error}",
-            "translation": "",
-            "placeholders": [
-                {
-                    "id": "Error",
-                    "string": "%[1]s",
-                    "type": "string",
-                    "underlyingType": "string",
-                    "argNum": 1,
-                    "expr": "err.Error()"
-                }
-            ]
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": ""
+        },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": "No se encontró un binario de Mumble válido en el sistema para ejecutar Wahay."
         },
         {
             "id": "please enter a valid password",

gui/locales/fr/out.gotext.json

@@ -193,19 +193,14 @@
             "fuzzy": true
         },
         {
-            "id": "Mumble client can't be used because:\n\n{Error}",
-            "message": "Mumble client can't be used because:\n\n{Error}",
-            "translation": "",
-            "placeholders": [
-                {
-                    "id": "Error",
-                    "string": "%[1]s",
-                    "type": "string",
-                    "underlyingType": "string",
-                    "argNum": 1,
-                    "expr": "err.Error()"
-                }
-            ]
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": ""
+        },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": ""
         },
         {
             "id": "please enter a valid password",

gui/locales/sv/out.gotext.json

@@ -197,19 +197,14 @@
             "fuzzy": true
         },
         {
-            "id": "Mumble client can't be used because:\n\n{Error}",
-            "message": "Mumble client can't be used because:\n\n{Error}",
-            "translation": "",
-            "placeholders": [
-                {
-                    "id": "Error",
-                    "string": "%[1]s",
-                    "type": "string",
-                    "underlyingType": "string",
-                    "argNum": 1,
-                    "expr": "err.Error()"
-                }
-            ]
+            "id": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "message": "The configured path to the Mumble binary is not valid or can't be used.\n\nPlease configure another path or download a bundled Wahay with Mumble in the following url:\n\nhttps://wahay.org/download.html",
+            "translation": ""
+        },
+        {
+            "id": "No valid Mumble binary found in the system in order to run Wahay.",
+            "message": "No valid Mumble binary found in the system in order to run Wahay.",
+            "translation": ""
         },
         {
             "id": "please enter a valid password",

gui/mumble.go

@@ -51,5 +51,14 @@ func init() {
 }
 
 func mumbleErrorTranslator(err error) string {
-	return i18n().Sprintf("Mumble client can't be used because:\n\n%s", err.Error())
+	switch err {
+	case client.ErrNoClientInConfiguredPath:
+		return i18n().Sprintf("The configured path to the Mumble binary is not valid or can't be used.\n\n" +
+			"Please configure another path or download a bundled Wahay with Mumble in the following url:" +
+			"\n\nhttps://wahay.org/download.html")
+	case client.ErrBinaryUnavailable:
+		return i18n().Sprintf("No valid Mumble binary found in the system in order to run Wahay.")
+	}
+
+	return err.Error()
 }