Merge pull request #14 from momentohq/chore/unitTestCredProvider

chore: add unit test for cred provider
momentohq · Dec 18, 2023 · 8bfd286 · 8bfd286
2 parents 324c222 + 7bd215f
commit 8bfd286
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 26 deletions.
diff --git a/lib/src/auth/credential_provider.dart b/lib/src/auth/credential_provider.dart
@@ -22,6 +22,16 @@ extension CredentialProviderErrorNames on CredentialProviderError {
   }
 }
 
+class Base64DecodedV1Token {
+  String apiKey = "";
+  String endpoint = "";
+  Base64DecodedV1Token(this.apiKey, this.endpoint);
+  Base64DecodedV1Token.fromJson(Map<String, dynamic> json)
+      : apiKey = json['api_key'] as String,
+        endpoint = json['endpoint'] as String;
+  Map toJson() => {'api_key': apiKey, 'endpoint': endpoint};
+}
+
 class _Endpoints {
   String cacheEndpoint = "";
   String controlEndpoint = "";
@@ -64,23 +74,24 @@ abstract class CredentialProvider {
 
   static _ParsedApiKey _parseJwtToken(String jwt) {
     Map<String, dynamic> claims = JwtDecoder.decode(jwt);
-    if (!claims["c"] || !claims["cp"]) {
+    if (!claims.containsKey("c") || !claims.containsKey("cp")) {
       throw "failed to parse jwt token";
     }
     return _ParsedApiKey(jwt, claims["cp"], claims["c"]);
   }
 
   static _ParsedApiKey _parseV1Token(String apiKey) {
-    final decoded = json.decode(utf8.decode(base64Decode(apiKey)));
-    if (!decoded["endpoint"]) {
+    final decodedJson = json.decode(utf8.decode(base64Decode(apiKey)));
+    final decoded = Base64DecodedV1Token.fromJson(decodedJson);
+    if (decoded.endpoint.isEmpty) {
       throw "invalid jwt missing required claim 'endpoint'";
     }
-    if (!decoded["api_key"]) {
+    if (decoded.apiKey.isEmpty) {
       throw "invalid jwt missing required claim 'api_key'";
     }
-    final endpoints = _Endpoints(decoded["endpoint"]);
+    final endpoints = _Endpoints(decoded.endpoint);
     return _ParsedApiKey(
-        decoded["api_key"], endpoints.controlEndpoint, endpoints.cacheEndpoint);
+        decoded.apiKey, endpoints.controlEndpoint, endpoints.cacheEndpoint);
   }
 }
 
@@ -106,16 +117,13 @@ class StringMomentoTokenProvider implements CredentialProvider {
   }
 
   @override
-  // TODO: implement apiKey
-  String get apiKey => throw UnimplementedError();
+  String get apiKey => _apiKey;
 
   @override
-  // TODO: implement cacheEndpoint
-  String get cacheEndpoint => throw UnimplementedError();
+  String get cacheEndpoint => _cacheEndpoint;
 
   @override
-  // TODO: implement controlEndpoint
-  String get controlEndpoint => throw UnimplementedError();
+  String get controlEndpoint => _controlEndpoint;
 }
 
 class EnvMomentoTokenProvider extends StringMomentoTokenProvider {

diff --git a/lib/src/client_sdk_dart_base.dart b/lib/src/client_sdk_dart_base.dart
@@ -0,0 +1,31 @@
+// // TODO: Put public facing types in this file.
+//
+// import '../generated/cachepubsub.pb.dart';
+// import 'package:grpc/grpc.dart';
+//
+// abstract class ITopicClient {
+//   void publish();
+// }
+//
+// class TopicClient implements ITopicClient {
+//   ClientChannel _channel;
+//
+//   TopicClient() {
+//     _channel = ClientChannel(host)
+//   }
+//   @override
+//   void publish() {
+//     // TODO: implement publish
+//   }
+//
+//   void close() {
+//
+//   }
+// }
+//
+// /// Checks if you are awesome. Spoiler: you are.
+// class Awesome {
+//   bool get isAwesome => true;
+// }
+//
+// PubsubApi api = PubsubApi();
diff --git a/lib/src/messages/values.dart b/lib/src/messages/values.dart
@@ -1,7 +1,7 @@
 sealed class Value {}
 
 class StringValue implements Value {
-  String _value;
+  final String _value;
   StringValue(String v) : _value = v;
   String get value => _value;
 }

diff --git a/test/placeholder_test.dart b/test/placeholder_test.dart
diff --git a/test/src/auth/credential_provider_test.dart b/test/src/auth/credential_provider_test.dart
@@ -0,0 +1,42 @@
+import 'package:client_sdk_dart/src/auth/credential_provider.dart';
+import 'package:test/test.dart';
+import 'dart:convert';
+
+// These tokens have valid syntax, but they don't actually have valid credentials.  Just used for unit testing.
+var fakeTestLegacyToken =
+    'eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJmb29Abm90LmEuZG9tYWluIiwiY3AiOiJjb250cm9sLXBsYW5lLWVuZHBvaW50Lm5vdC5hLmRvbWFpbiIsImMiOiJjYWNoZS1lbmRwb2ludC5ub3QuYS5kb21haW4ifQo.rtxfu4miBHQ1uptWJ2x3UiAwwJYcMeYIkkpXxUno_wIavg4h6YJStcbxk32NDBbmJkJS7mUw6MsvJNWaxfdPOw';
+var fakeTestV1ApiKey =
+    'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2NzgzMDU4MTIsImV4cCI6NDg2NTUxNTQxMiwiYXVkIjoiIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSJ9.8Iy8q84Lsr-D3YCo_HP4d-xjHdT8UCIuvAYcxhFMyz8';
+
+var decodedV1Token =
+    Base64DecodedV1Token(fakeTestV1ApiKey, "test.momentohq.com");
+var base64EncodedFakeV1AuthToken =
+    base64.encode(utf8.encode(jsonEncode(decodedV1Token)));
+var fakeSessionToken =
+    'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InN6eTVJLU5oaDZONjZUbTJfeld2UyJ9.eyJlbWFpbCI6ImNocmlzQG1vbWVudG9ocS5jb20iLCJpc3MiOiJodHRwczovL2xvZ2luLXByZXByb2QuZ29tb21lbnRvLmNvbS8iLCJzdWIiOiJnb29nbGUtb2F1dGgyfDExMDE5OTE5NjYwNDc0NDEwMjQyNSIsImF1ZCI6WyJodHRwczovL3ByZXByb2QiLCJodHRwczovL3ByZXByb2QtbW9tZW50by51cy5hdXRoMC5jb20vdXNlcmluZm8iXSwiaWF0IjoxNjg0Mjg1NDIyLCJleHAiOjE2ODQzNzE4MjIsImF6cCI6InRibFdPYk02Zk9iNkJsQWwzUjFPcWZUNTlrTEY3VGJiIiwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCJ9.CKJn23XJ9L-seTfOo8OdAbBSP-2DPEM7hvOT1FayojJJvNmyNHzPxcftANlL64lpu5KWIZHwkNaptwkT8v2m7TVeqzDUR52Zqzk7TvQv-FQD_iI4INebPQrCnCKF2ByqC3fdlfrdXBxErF7rOJRKwyugKNhG7WVtjlm9pKOnIIFpUW_0mxWBObrgMhr1qIOaRPoGhyu1TXVgbdn6GLwBDeDI5XbHvgWiMixgs1BpGe_sOOYIcy8l0_TgwQtqUg9GG9Q88Pdde90w_eGLb6bB2QOqXwksBr8zK-z-VZZsiNVdzokKvAvUt3Ev4F1N8Np9ehFbXnzNsTmh1VqkNESy4w';
+
+const testControlEndpoint = 'control-plane-endpoint.not.a.domain';
+const testCacheEndpoint = 'cache-endpoint.not.a.domain';
+
+void main() {
+  group('credential_provider', () {
+    group('fromString', () {
+      test('parses a valid legacy token', () {
+        var authProvider = CredentialProvider.fromString(fakeTestLegacyToken);
+        expect(authProvider.apiKey, equals(fakeTestLegacyToken));
+        expect(authProvider.controlEndpoint, equals(testControlEndpoint));
+        expect(authProvider.cacheEndpoint, equals(testCacheEndpoint));
+      });
+
+      test('parses a valid v1 auth token', () {
+        var authProvider =
+            CredentialProvider.fromString(base64EncodedFakeV1AuthToken);
+        expect(authProvider.apiKey, equals(fakeTestV1ApiKey));
+        expect(authProvider.controlEndpoint,
+            equals('control.${decodedV1Token.endpoint}'));
+        expect(authProvider.cacheEndpoint,
+            equals('cache.${decodedV1Token.endpoint}'));
+      });
+    });
+  });
+}