Removing password and username from all the testing, as we've migrated everything to use CustomID.

Summary:
Removing password and username from all the testing, as we've migrated everything to use CustomID.
Documenting testTitleData.json, and some JCU requirements.
fixes T2232

Test Plan: Jenker!

Reviewers: zac-playfab, #devtools_in-progress

Reviewed By: zac-playfab, #devtools_in-progress

Subscribers: zac-playfab

Maniphest Tasks: T2232

Differential Revision: https://phab.playfabdev.com/D2492

Author: pgilmorepf

JenkinsConsoleUtility/readme.md

@@ -0,0 +1,20 @@
+JenkinsConsoleUtility Readme
+====
+
+We at PlayFab use Jenkins to automate most of our testing, both for our closed-source API-Server, and our open-source SDKs.
+
+JenkinsConsoleUtility (shortened to JCU) is open source, and focuses exclusively on relaying test reports from SDKs built to difficult targets, back into Jenkins in a format familiar to Jenkins. For example, many of our SDKs are deployed to phones or devices, which are not running our Jenkins builder. Jenkins kicks off a build to the device, and then runs JCU, which waits for the device to upload test results.  When finished, those test results are posted to the Jenkins job.
+
+There are some requirements to make this work:
+* We highly suggest you create a test title which is exclusively for running our tests, which you will not use for your actual game development
+* In your own test title, a specific set of CloudScript functions must be appended to your own
+ * They are provided here: https://github.com/PlayFab/SDKGenerator/blob/master/JenkinsConsoleUtility/jcuCloudScript.js
+* You must be running our testing-example projects, provided with most of our sdks
+ * Any sdk with semi-weekly releases should have this test project included with the SDK
+* You must provide a testTitleData.json file to the test-example
+ * See the detailed described here: https://github.com/PlayFab/SDKGenerator/blob/master/JenkinsConsoleUtility/testTitleData.md
+* You must ENABLE the "Allow client to post player statistics" option in the PlayFab Game Manager
+ * PlayFab Website -> Login -> Find your title -> Settings -> API-Features -> check-box
+ * For server-authoritative games, or games with leaderboards, this is not suggested, hence the importance of creating a separate title
+
+Full documentation of the JCU will be posted here eventually. This isn't designed to be a primary product for our customers to use. It's open source because there's nothing sensitive here, and we're happy to demonstrate our SDK testing process.

JenkinsConsoleUtility/testTitleData.md

@@ -0,0 +1,45 @@
+testTitleData.json
+====
+
+testTitleData.json is a file that is required by all of the example-test projects in most of the PlayFab sdks
+
+Each example project serves two main purposes in each SDK:
+* Demonstrate to a developer using PlayFab, how to make successful API calls
+ * In particular, we demonstrate specific areas of maximum first-time-user benefit, like logging in, Player data and statistics
+ * We also demonstrate Cloud Script, which is one of our most powerful features, but can also be somewhat difficult to use properly
+* We also use this same code internally to determine if the SDK is actually working properly
+ * This is our internal testing process, made transparent to all of our users, and in fact, usable by their own test-titles
+
+This last portion, "running our tests on your own title" comes with a few requirements
+* You must specify a testTitleData.json file which tells our tests which title to use
+* You must unlock a security setting that allows clients to set player statistics (This setting should NOT be set for a live game which is server-authoritative)
+* NOTE: Some tests have a hard coded titleId="6195" in those tests, which is us being sloppy, and we intend to fix these over time
+ * Generally, it shouldn't hurt anything if you run your tests on our title, but it's better for both of us if you change this to your title when you see it
+
+The format of the testTitleData.json file is as follows:
+```json 
+{
+	"titleId": "<Found in PlayFab Game Manager>",
+	"developerSecretKey": "<Found in PlayFab Game Manager>",
+	"titleCanUpdateSettings": "true",
+	"userEmail": "<[email protected]>",
+	"characterName": "<CharName>"
+}
+```
+
+Please note characterName is deprecated, and has already been removed from most of the test-examples in our SDKs.  For those few that remain, this can be any valid character name (Those test suites will usually create the character).
+
+Please note, the path to testTitleData.json is hard coded in most of the examples to this: "C:/depot/pf-main/tools/SDKBuildScripts/testTitleData.json"
+
+Our own testTitleData.json is located at this location and contains the secret key for title 6195, and thus we do not publish this file.  You should change this path to your own testTitleData.json location, wherever it may be.
+
+Philosophy
+====
+
+We feel that by showing you our own testing files, as examples of how to use our SDK, we are guaranteeing a few things:
+* The example code in those files always works
+ * Those tests must pass on our own automated testing server in order to be published, and therefore, it is a guaranteed working example of how to make those calls
+* Transparency - This is the testing we do for our SDKs
+ * Note, we have EXTENSIVE testing of the API-server, which is not represented by these tests.  These are just the SDK tests
+* Promote testing
+ * Every one of our SDK testing-examples comes with a working test environment, which you can use in your own projects

targets/actionscript/source/PlayFabApiTests.as

@@ -33,10 +33,7 @@ package
         private static var TITLE_CAN_UPDATE_SETTINGS:Boolean = false;
 
         // Fixed values provided from testInputs
-        private static var USER_NAME:String;
         private static var USER_EMAIL:String;
-        private static var USER_PASSWORD:String;
-        private static var CHAR_NAME:String;
 
         // Information fetched by appropriate API calls
         private static var playFabId:String;
@@ -90,19 +87,13 @@ package
             PlayFabSettings.TitleId = testTitleData.titleId;
             PlayFabSettings.DeveloperSecretKey = testTitleData.developerSecretKey;
             TITLE_CAN_UPDATE_SETTINGS = testTitleData.titleCanUpdateSettings.toLowerCase() == "true";
-            USER_NAME = testTitleData.userName;
             USER_EMAIL = testTitleData.userEmail;
-            USER_PASSWORD = testTitleData.userPassword;
-            CHAR_NAME = testTitleData.characterName;
 
             TITLE_INFO_SET = Boolean(PlayFabSettings.TitleId)
                 || Boolean(PlayFabSettings.TitleId)
                 || Boolean(PlayFabSettings.DeveloperSecretKey)
                 || Boolean(TITLE_CAN_UPDATE_SETTINGS)
-                || Boolean(USER_NAME)
-                || Boolean(USER_EMAIL)
-                || Boolean(USER_PASSWORD)
-                || Boolean(CHAR_NAME);
+                || Boolean(USER_EMAIL);
             return TITLE_INFO_SET;
         }
 
@@ -122,15 +113,15 @@ package
 
         /// <summary>
         /// CLIENT API
-        /// Try to deliberately log in with an inappropriate password,
+        /// Deliberately log in with an inappropriate password,
         ///   and verify that the error displays as expected.
         /// </summary>
         private function InvalidLogin() : void
         {
             var request:com.playfab.ClientModels.LoginWithEmailAddressRequest = new com.playfab.ClientModels.LoginWithEmailAddressRequest();
             request.TitleId = PlayFabSettings.TitleId;
             request.Email = USER_EMAIL;
-            request.Password = USER_PASSWORD + "INVALID";
+            request.Password = "INVALID";
             PlayFabClientAPI.LoginWithEmailAddress(request, Wrap(InvalidLogin_Success, "InvalidLogin_Success"), Wrap(InvalidLogin_Failure, "InvalidLogin_Success"));
         }
         private function InvalidLogin_Success(result:com.playfab.ClientModels.LoginResult) : void

targets/cpp-cocos2dx/ExampleSource/Classes/PlayFabApiTest.h

@@ -312,10 +312,7 @@ namespace PlayFabApiTest
 
         // A bunch of constants loaded from testTitleData.json
         static const std::string TEST_TITLE_DATA_LOC;
-        static std::string userName;
         static std::string userEmail;
-        static std::string userPassword;
-        static std::string characterName;
         static bool TITLE_CAN_UPDATE_SETTINGS;
         const static std::string TEST_DATA_KEY;
         const static std::string TEST_STAT_NAME;
@@ -359,18 +356,12 @@ namespace PlayFabApiTest
                 // POPULATE THIS SECTION WITH REAL INFORMATION
                 playFabSettings->titleId = ""; // The titleId for your title, found in the "Settings" section of PlayFab Game Manager
                 TITLE_CAN_UPDATE_SETTINGS = true; // Make sure this is enabled in your title, found in the "Settings" section, "API Features" section of PlayFab Game Manager
-                userName = ""; // This is an arbitrary user name, which will be utilized for this test
                 userEmail = ""; // This is the email for the user
-                userPassword = ""; // This is the password for the user
-                characterName = ""; // This should be a valid character on the given user's account
             }
 
             // Verify all the inputs won't cause crashes in the tests
             return !playFabSettings->titleId.empty()
-                && !userName.empty()
-                && !userEmail.empty()
-                && !userPassword.empty()
-                && !characterName.empty();
+                && !userEmail.empty();
         }
 
         static void PostTestResultsToCloudScript()
@@ -448,15 +439,8 @@ namespace PlayFabApiTest
             if (each != end) blah = each->value.GetString();
             TITLE_CAN_UPDATE_SETTINGS = (blah.compare("true") == 0 || blah.compare("True") == 0 || blah.compare("TRUE") == 0);
 
-            each = testInputs.FindMember("userName");
-            if (each != end) userName = each->value.GetString();
             each = testInputs.FindMember("userEmail");
             if (each != end) userEmail = each->value.GetString();
-            each = testInputs.FindMember("userPassword");
-            if (each != end) userPassword = each->value.GetString();
-
-            each = testInputs.FindMember("characterName");
-            if (each != end) characterName = each->value.GetString();
         }
         // Start a test, and block until the threaded response arrives
         static void StartTest(PfTestContext& testContext)
@@ -501,7 +485,7 @@ namespace PlayFabApiTest
         {
             LoginWithEmailAddressRequest request;
             request.Email = userEmail;
-            request.Password = userPassword + "INVALID";
+            request.Password = "INVALID";
             PlayFabClientAPI::LoginWithEmailAddress(request, InvalidLoginSuccess, InvalidLoginFail, &testContext);
         }
         static void InvalidLoginSuccess(const LoginResult& result, void* customData)
@@ -526,7 +510,7 @@ namespace PlayFabApiTest
         static void InvalidRegistration(PfTestContext& testContext)
         {
             RegisterPlayFabUserRequest request;
-            request.Username = userName;
+            request.Username = "x";
             request.Email = "x";
             request.Password = "x";
             PlayFabClientAPI::RegisterPlayFabUser(request, InvalidRegistrationSuccess, InvalidRegistrationFail, &testContext);
@@ -831,10 +815,7 @@ namespace PlayFabApiTest
     std::string PlayFabApiTests::_outputSummary;
     PlayFabSettings* PlayFabApiTests::playFabSettings;
     const std::string PlayFabApiTests::TEST_TITLE_DATA_LOC = "C:/depot/pf-main/tools/SDKBuildScripts/testTitleData.json";
-    std::string PlayFabApiTests::userName;
     std::string PlayFabApiTests::userEmail;
-    std::string PlayFabApiTests::userPassword;
-    std::string PlayFabApiTests::characterName;
     bool PlayFabApiTests::TITLE_CAN_UPDATE_SETTINGS = false;
     const std::string PlayFabApiTests::TEST_DATA_KEY = "testCounter";
     const std::string PlayFabApiTests::TEST_STAT_NAME = "str";

targets/cpp-windows/UnittestRunner/PlayFabApiTest.cpp

@@ -39,9 +39,7 @@ namespace UnittestRunner
     bool TITLE_CAN_UPDATE_SETTINGS = false;
 
     // Fixed values provided from testInputs
-    string USER_NAME;
     string USER_EMAIL;
-    string USER_PASSWORD;
     string CHAR_NAME;
 
     // Information fetched by appropriate API calls
@@ -84,22 +82,16 @@ namespace UnittestRunner
             if (each != end) blah = each->value.GetString(); else TITLE_INFO_SET = false;
             TITLE_CAN_UPDATE_SETTINGS = (blah.compare("true") == 0 || blah.compare("True") == 0 || blah.compare("TRUE") == 0);
 
-            each = testInputs.FindMember("userName");
-            if (each != end) USER_NAME = each->value.GetString(); else TITLE_INFO_SET = false;
             each = testInputs.FindMember("userEmail");
             if (each != end) USER_EMAIL = each->value.GetString(); else TITLE_INFO_SET = false;
-            each = testInputs.FindMember("userPassword");
-            if (each != end) USER_PASSWORD = each->value.GetString(); else TITLE_INFO_SET = false;
 
             each = testInputs.FindMember("characterName");
             if (each != end) CHAR_NAME = each->value.GetString(); else TITLE_INFO_SET = false;
 
             // Verify all the inputs won't cause crashes in the tests
             TITLE_INFO_SET &= !PlayFabSettings::titleId.empty()
                 && !PlayFabSettings::developerSecretKey.empty()
-                && !USER_NAME.empty()
                 && !USER_EMAIL.empty()
-                && !USER_PASSWORD.empty()
                 && !CHAR_NAME.empty();
         }
 
@@ -181,7 +173,7 @@ namespace UnittestRunner
             LoginWithEmailAddressRequest request;
             request.TitleId = PlayFabSettings::titleId;
             request.Email = USER_EMAIL;
-            request.Password = USER_PASSWORD + "INVALID";
+            request.Password = "INVALID";
 
             PlayFabClientAPI::LoginWithEmailAddress(request, &LoginCallback, &LoginFailedCallback, nullptr);
             ClientApiWait();

targets/csharp-flat/UnittestRunner/PlayFabApiTest.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using Newtonsoft.Json.Linq;
 using PlayFab.ClientModels;
+using PlayFab.Internal;
 
 namespace PlayFab.UUnit
 {
@@ -25,9 +26,7 @@ public class PlayFabApiTest : UUnitTestCase
         private static bool TITLE_CAN_UPDATE_SETTINGS = false;
 
         // Fixed values provided from testInputs
-        private static string USER_NAME;
         private static string USER_EMAIL;
-        private static string USER_PASSWORD;
         private static string CHAR_NAME;
 
         // Information fetched by appropriate API calls
@@ -52,18 +51,14 @@ public static void SetTitleInfo(Dictionary<string, string> testInputs)
             TITLE_INFO_SET &= testInputs.TryGetValue("titleCanUpdateSettings", out eachValue);
             TITLE_INFO_SET &= bool.TryParse(eachValue, out TITLE_CAN_UPDATE_SETTINGS);
 
-            TITLE_INFO_SET &= testInputs.TryGetValue("userName", out USER_NAME);
             TITLE_INFO_SET &= testInputs.TryGetValue("userEmail", out USER_EMAIL);
-            TITLE_INFO_SET &= testInputs.TryGetValue("userPassword", out USER_PASSWORD);
 
             TITLE_INFO_SET &= testInputs.TryGetValue("characterName", out CHAR_NAME);
 
             // Verify all the inputs won't cause crashes in the tests
             TITLE_INFO_SET &= !string.IsNullOrEmpty(PlayFabDefaultSettings.TitleId)
                 && !string.IsNullOrEmpty(PlayFabDefaultSettings.DeveloperSecretKey)
-                && !string.IsNullOrEmpty(USER_NAME)
                 && !string.IsNullOrEmpty(USER_EMAIL)
-                && !string.IsNullOrEmpty(USER_PASSWORD)
                 && !string.IsNullOrEmpty(CHAR_NAME);
 
             Client = new PlayFabClientAPI();
@@ -89,7 +84,7 @@ protected override void TearDown()
         public void InvalidLogin()
         {
             // If the setup failed to log in a user, we need to create one.
-            var task = Client.LoginWithEmailAddressAsync(Client.Settings.TitleId, USER_EMAIL, USER_PASSWORD + "_INVALID");
+            var task = Client.LoginWithEmailAddressAsync(Client.Settings.TitleId, USER_EMAIL, "INVALID");
             try
             {
                 task.Wait();
@@ -109,40 +104,16 @@ public void InvalidLogin()
         [UUnitTest]
         public void LoginOrRegister()
         {
-            if (!Client.IsClientLoggedIn()) // If we haven't already logged in...
-            {
-                var loginTask = Client.LoginWithEmailAddressAsync(Client.Settings.TitleId, USER_EMAIL, USER_PASSWORD);
-
-                try
-                {
-                    loginTask.Wait();
-                }
-                catch (Exception ex)
-                {
-                    UUnitAssert.True(false, ex.Message);
-                }
-                UUnitAssert.True(true);
-
-                _playFabId = loginTask.Result.PlayFabId; // Needed for subsequent tests
-            }
-
-            if (Client.IsClientLoggedIn())
-                return; // Success, already logged in
-
-            // If the setup failed to log in a user, we need to create one.
-            var registerTask = Client.RegisterPlayFabUserAsync(Client.Settings.TitleId, USER_NAME, USER_EMAIL, USER_PASSWORD);
+            var loginTask = Client.LoginWithCustomIDAsync(Client.Settings.TitleId, PlayFabVersion.BuildIdentifier, true);
             try
             {
-                registerTask.Wait();
+                loginTask.Wait();
             }
             catch (Exception ex)
             {
                 UUnitAssert.True(false, ex.Message);
             }
-            UUnitAssert.True(true);
-
-            _playFabId = registerTask.Result.PlayFabId; // Needed for subsequent tests
-
+            _playFabId = loginTask.Result.PlayFabId; // Needed for subsequent tests
             UUnitAssert.True(Client.IsClientLoggedIn(), "User login failed");
         }
 
@@ -156,7 +127,7 @@ public void LoginWithAdvertisingId()
             Client.Settings.AdvertisingIdType = PlayFabDefaultSettings.AD_TYPE_ANDROID_ID;
             Client.Settings.AdvertisingIdValue = "PlayFabTestId";
 
-            var loginTask = Client.LoginWithEmailAddressAsync(Client.Settings.TitleId, USER_EMAIL, USER_PASSWORD);
+            var loginTask = Client.LoginWithCustomIDAsync(Client.Settings.TitleId, PlayFabVersion.BuildIdentifier, true);
             try
             {
                 loginTask.Wait();
@@ -165,6 +136,8 @@ public void LoginWithAdvertisingId()
             {
                 UUnitAssert.True(false, ex.Message);
             }
+            _playFabId = loginTask.Result.PlayFabId; // Needed for subsequent tests
+            UUnitAssert.True(Client.IsClientLoggedIn(), "User login failed");
             UUnitAssert.StringEquals(PlayFabDefaultSettings.AD_TYPE_ANDROID_ID + "_Successful", Client.Settings.AdvertisingIdType);
         }