Updating ServerConfig methods

Author: Pijush Chakraborty

bug-bash-test.py

@@ -0,0 +1,49 @@
+import firebase_admin
+from firebase_admin import credentials
+from firebase_admin import remote_config
+import asyncio
+
+# [Bug Bash 101] Credentials
+# Load creds for authentication - Update the json key from the one downloaded from the console.
+cred = credentials.Certificate('firebase_admin/rc-custom-test-firebase-adminsdk-elxq9-bf8684bef7.json')
+default_app = firebase_admin.initialize_app(cred)
+
+# [Bug Bash 101] Default Config
+# Create default template for initializing ServerTemplate
+# For bug bash, update the default config to any config that you want to initialize
+# the app with. The configs will be cached and might get updated during evaluation of the template.
+default_config = {
+    'default_key_str': 'default_val_str',
+    'default_key_number': 123
+}
+
+# Create initial template
+template = remote_config.init_server_template(app=default_app, default_config=default_config)
+
+# Load the template from the backend
+asyncio.run(template.load())
+
+# [Bug Bash 101] Custom Signals
+# Evaluate template - pass custom signals
+# Update the custom signals being passed in evaluate to test how variations of the 
+# signals cause changes to the config evaluation.
+config = template.evaluate(
+      # Update custom vars 
+      {
+        'custom_key_str': 'custom_val_str',
+        'version_key': '12.1.3.-1'
+      }
+    )
+
+# [Bug Bash 101] Verify Evaluation
+# Update the following print statements to verify if config is being created properly.
+# Print default config values 
+# print('[Default Config] default_key_str: ', config.get_string('default_key_str'))
+# print('[Default Config] default_key_number: ', config.get_int('default_key_number'))
+
+# Verify evaluated config
+print('[Evluated Config] Config values:', config.get_string('test_server'))
+
+# Verify value and source for configs
+print('Config Value:', config.get_value('test_server').as_string(), 
+      'Value Source:', config.get_value('test_server').get_source())

firebase_admin/pijushc-dev-firebase-adminsdk-j8pmi-ea587598b5.json

@@ -0,0 +1,13 @@
+{
+  "type": "service_account",
+  "project_id": "pijushc-dev",
+  "private_key_id": "ea587598b57a2516b1f215330a298c58f25d80cd",
+  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCcPWs5k8RO4zU4\nB2ISSNfkiJM/hoRZ48Fgb8X7/DkxBR7CgDpnZdarl/9P1POLIf+SLDarvWLTd5Qs\n4fkeat5h1MDMetUAqsfZ43kUFdOISwLxzbfHfXloRn6q/qzJQlLHlkjAvi8i0LbN\n1epy3v36I7OIL7+ACdY/HVEEJdjUjWxBq2QNEqOLCDXtEVDgXlLecHGGg8jkqtXT\nHx2dWCLJogfRVmLhVKMtma4l2CVDWke2cBQV+M6suzSZxjgx5ORqCMd3ZIbyxaf7\nuaW6qYPOuKjmx1zm+xQAgzuv1F49tr8yQ3MUFtdvbA63oeRfi0p0VbAD6+F8kS0t\nTbjX45qrAgMBAAECggEABk8qodAYSNE/CGyv5qofYcCsJZASjyi12eWZmqPkUVjy\nFYulECDaKuK/8iLY1OECF46GhKfosj5tcuSLMVHCejPjtz4slNLQsDlR3eBFwwa4\nbzhN+BXWjcHvAou3QYdWnW2xsWrcr2y7PROq3ImpuuyvJsw60PpUtwbBi0fV+jtN\nn7EVRPTprhRTlnaObaX38MS5zNffA54x1p83MnBGB4mCZrlg4tCZIbehjhj6CHaP\nwu2QNYbYB8+iZkN7fcWze8ytvTxAZJD0IBVU/jJQFIJfdw8XyKlilKvTcdS7eTF8\nv9lNTyBAYPQdRRK/axjARzYhL1T1f/Kb9LH56H5V+QKBgQDNro1qGjBcyd+ij4Fv\nu7Ryst8o28tIJVaofSGV/QnQcLnhuTSMqIIks603EvgtpHX0NEseSTiUcyJtrgEP\nHzm1QWHvy/rwLPMAmFp8ArbBRdPog14YYRNzZD+CECLYW8RvvrRDFhgArXFnFe53\nXhtnEU7yXs4p5JlgSKxjvIvlWQKBgQDCdmqLCs6szpqCXG+IhHAR6mcaLkJPj3mR\nbCL7fuNW9dmYvzV2cGVi1DJ48BjIzvVUSIJjufrXWbIZr0aoyEN2mFAFrHo24Y0i\nO9AKkXfJkKL5/6CEPpjpr4XtNwNHsQERRNVBEn8nHy49TjhJkYz32WLjOpnKqKTE\nA0CXRivLowKBgQCnhNBWp2fWWvES1HCmkSmh9X9+Jq3FX+vZpLizEXlp1DYA2zgq\ni6Abxl+AqKmLexQ6xlCcJSS4+6EB1aO1LkhxEQR0Kx2Begqc5Hll4Uv51CaIjF4Z\n2w7df7ud8gh/URaHsLneneMEwj7Hp/wmKnaFFnrHOmINistEuUv2m30RWQKBgFiv\nKGfAxgCJOG27OiJIQ9Pn0p1d+1/NTuPDLTEE7Sj7dgDzMq6RE6u+mkYNOUBbIgcO\nCmjwqDUN8utDxDW1Hw8250evIQ1mT7cNEBPBw59pFupsagflhFcOdUV5kUVgs9vs\nSFUk2lg9IBlVUtY6Ss+9lBuM3hZOUtYRpaNXnSGBAoGBAL3zFdEjgmwNnpnZkNna\nFdSXX78gNGg1zQfgiLntLgY7Sf5dVYTU5+j6RLs7/3WTFbcrhJ14AMgdW7CgM5Gs\nkMoVFOjjyrC/CaVzmCpFRHY9Q191R/dFnfIRQBTCEIs/vWlI+Nu9TG1u4lA9EPxb\nzhTi3qfs/XPLiuA1ZiOI0u4E\n-----END PRIVATE KEY-----\n",
+  "client_email": "firebase-adminsdk-j8pmi@pijushc-dev.iam.gserviceaccount.com",
+  "client_id": "104705823758570910458",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-j8pmi%40pijushc-dev.iam.gserviceaccount.com",
+  "universe_domain": "googleapis.com"
+}

firebase_admin/rc-custom-test-firebase-adminsdk-elxq9-bf8684bef7.json

@@ -0,0 +1,13 @@
+{
+  "type": "service_account",
+  "project_id": "rc-custom-test",
+  "private_key_id": "bf8684bef7ee2778a34c022b9a3d00eb4ebf5f1b",
+  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC3lEaoxzEjPZdM\nkkyuHDeldit6asqLbm71k5VwdZKN1Upur4rCZO99fe8nNoYoj4w5513jP0fBQPeM\nU57W2SguGq05+5I1Df7p0WwN7+QQLOh7KcGPxnIOd8EzF+HY2JfW2Cs3+02Rs5ZR\nDeAN706YcmzNyzwyoX4it+EEHF0JS0b6divcVH8U1Hx8fR2TdNVggB5LbrBZohKT\nQi9JFOWh+3eDnbSAX7iCwM/rOW2UgwtrmHiSesB8ohPzgmehUt53NzkJJiucK0ba\nd7gebOxU7RzxZpfT5WZw8H1wlkuJoBgMaXaRgbzhECTG9oWuqtnFsjP8HEcfkBg5\nPqRa8lx3AgMBAAECggEAHLua8Zi3sqXVs/jkAo5NEVs1A+SKDhe7SzmNtrvYM9XR\n4BAenj1xFIms8EzC479P+dIiKkrBvtgdxrthzYvQk6K+QSiEYkRuBQevq2DEJ9n3\niytmbcvoFyacORSAV1HTNh/AZ/Mv2WGr4cTTsCqn+QlTyUQJiH0pQmLYV63ey/DV\nuHgjwzDQlPMGW9lcuiaXUz/DeOKEnDG+VUXrZyDZdIMAuToi58kay4tU5iWUpHBc\nbh9gfryIWdRAJUC74aCBjobwHjGzdcOTWMzNLetI/fEuQwcLVFBjPlH/bGC9yMvq\nXB29m1WtFsD0aF1Eg7VIs7EVCbZwtyY3T/EQcBpZ6QKBgQDqrRF2oePWyt3LhNwr\nMBGoeSKek1I3+I9lQvYwYVn4J3aI2bjDVSiHONbWUnS2lV4oUjt22Dv6lr1vfmFn\n/uMQ5RhKzbfbnVPtz8sDK3OSKb1B3JImv5qv8RJj3HZJlGaNX0QUnosJ6c0r+Fw1\nuIrBSTlXCbV0SmgpeByfbiy9fwKBgQDIQp2EfaX1oAnzXpWwbPaMlO3L+QAkzeDP\nwR9q4ci26a4rHfl0JZzHhzsjQEhbjW0EYU7EAVKzBW/K8RHyKTjBR0lN9xoqOTDK\nzObIeQVVfvoXspPePwnShXoaKxAeRWUwLiK05Jf5sl2iglD3Oebu3tWcf+kNhIIN\n+N2gat/NCQKBgElLtrmbxKKQiAeJvo5KnClHdFWc48ARhQ/2gxgHP+duw+noPnnb\nviXFzevwov1n15m2XVY4ITuaGx6YlWm6xUbAlv6+E9+m2tDa5qhdyOHs4WyRrKAn\nlfO/0qOX9uXyULl0+LmL7xcwi+Fg18P7mHLYIO2bXa4tkyzok+ADtDuXAoGBALPL\n21CQ3ufggA6Y5Rw5OEKPk9CGBrMEhMsCQQrdHC/dLhpYFxdIjbI2n8nOdSh9mVtN\nYkJoTa+dOfmi5tHcYLBnKFFvgXZXUo9B2BI1VaylDDUqh8gKIO96F15XO2lyNJ9F\nTLPMaQYuNhMpnTfaLJRaTL7tuHgCeCHDRng4fCbBAoGAD2oPTQWkTN/m2iAA9EJP\n0VCWwiVHacd1vc5zJT7D+d7ot5um35oX3Lw6UDlaqM+ehPh1wAOriI15rFZSwmLV\nYXGS5LU5BvOruE4TtOFX5sr8B1esEq3KWoX15+3irOLx4Q7NdBIx+6IrRtp8CZWS\nRVqMnC+hroOAG2MneZ5plOA=\n-----END PRIVATE KEY-----\n",
+  "client_email": "firebase-adminsdk-elxq9@rc-custom-test.iam.gserviceaccount.com",
+  "client_id": "103984069070765900583",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-elxq9%40rc-custom-test.iam.gserviceaccount.com",
+  "universe_domain": "googleapis.com"
+}

firebase_admin/remote_config.py

@@ -185,21 +185,19 @@ def __init__(self, config_values):
         self._config_values = config_values # dictionary of param key to values
 
     def get_boolean(self, key):
-        return self.get_value(key).as_boolean()
+        return self._get_value(key).as_boolean()
 
     def get_string(self, key):
-        return self.get_value(key).as_string()
+        return self._get_value(key).as_string()
 
     def get_int(self, key):
-        return self.get_value(key).as_int()
+        return self._get_value(key).as_int()
 
     def get_float(self, key):
-        return self.get_value(key).as_float()
+        return self._get_value(key).as_float()
 
-    def get_value(self, key):
-        if key in self._config_values:
-            return self._config_values[key]
-        return _Value('static')
+    def _get_value(self, key):
+        return self._config_values.get(key, _Value('static'))
 
 
 class _RemoteConfigService:

tests/test_remote_config.py

@@ -331,8 +331,7 @@ def test_evaluate_default_when_defined(self):
             template_data=ServerTemplateData('etag', template_data)
         )
         server_config = server_template.evaluate()
-        assert server_config.get_value('dog_type').as_string() == 'shiba'
-        assert server_config.get_value('dog_type').get_source() == 'default'
+        assert server_config.get_string('dog_type') == 'shiba'
 
     def test_evaluate_return_numeric_value(self):
         app = firebase_admin.get_app()