Merge pull request #21 from browserstack/merge_sdk_to_main

Merge sdk to main

Author: karanshah-browserstack

.gitignore

@@ -4,4 +4,8 @@ TestResult.xml
 bin
 obj
 .vs
-.DS_Store
+.DS_Store
+browserstack.err
+log
+BrowserStackLocal.exe
+local.log

README.md

@@ -3,17 +3,31 @@
 
 <img src="https://github.com/browserstack/cucumber-java-browserstack/blob/master/src/test/resources/img/browserstack.png?raw=true" width="60" height="60" alt="BrowserStack" > <img src="https://xunit.net/images/full-logo.svg" width="150" height="60" alt="XUnit">
 
-## Setup
+## Run Sample Build
 * Clone the repo
-* Install dependencies `dotnet build`
-* Update `config.json` files inside the `XUnit-BrowserStack` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings). 
-
-## Running your tests
-* To run tests, run `dotnet test --filter "profile=parallel"`
-* To run local tests, run `dotnet test --filter "profile=local"`
+* Open the solution `XUnit-BrowserStack.sln` in Visual Studio
+* Build the solution
+* Update `browserstack.yml` file with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
+### Running your tests from CLI
+* To run the test suite having cross-platform with parallelization, dotnet test --filter "Category=sample-test"
+* To run local tests, dotnet test --filter "Category=sample-local-test"
+### Running your tests from Test Explorer
+- To run a parallel tests, run test with fixture `sample-test`
+- To run local tests, run test with fixture `sample-local-test`
 
  Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
 
+ ## Integrate your test suite
+
+This repository uses the BrowserStack SDK to run tests on BrowserStack. Follow the steps below to install the SDK in your test suite and run tests on BrowserStack:
+
+* Create sample browserstack.yml file with the browserstack related capabilities with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings) and place it in your root folder.
+* Add nuget library BrowserStack.TestAdapter
+```sh
+dotnet add BrowserStack.TestAdapter
+```
+* Build project `dotnet build`
+
 ## Notes
 * You can view your test results on the [BrowserStack Automate dashboard](https://www.browserstack.com/automate)
 * To test on a different set of browsers, check out our [platform configurator](https://www.browserstack.com/automate/c-sharp#setting-os-and-browser)
@@ -25,14 +39,20 @@
   export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
   ```
 
-  * For Windows:
+  * For Windows Cmd:
   ```
   set BROWSERSTACK_USERNAME=<browserstack-username>
   set BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
   ```
 
+  * For Windows Powershell:
+  ```
+  $env:BROWSERSTACK_USERNAME=<browserstack-username>
+  $env:BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+  ```
+
 ## Addtional Resources
 * [Documentation for writing Automate test scripts in C#](https://www.browserstack.com/docs/automate/selenium/getting-started/c-sharp)
 * [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities)
 * [Browsers & mobile devices for selenium testing on BrowserStack](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate)
-* [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api)
+* [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api)

XUnit-BrowserStack/.config/dotnet-tools.json

@@ -0,0 +1,5 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {}
+}

XUnit-BrowserStack/BaseFixture.cs

@@ -10,117 +10,26 @@ public class BaseFixture : IDisposable
     {
 
         private RemoteWebDriver? WebDriver;
-        private Local? browserStackLocal;
-
 
         public RemoteWebDriver GetDriver(string platform, string profile)
         {
-            // Get Configuration for correct profile
-            string currentDirectory = Directory.GetCurrentDirectory();
-            string path = Path.Combine(currentDirectory, "config.json");
-            JObject config = JObject.Parse(File.ReadAllText(path));
-            if (config is null)
-                throw new Exception("Configuration not found!");
-
-            // Get Platform specific capabilities
-            JObject capabilities = config.GetValue("environments").Where(x => x is JObject y && x["browserName"].ToString().Equals(platform)).ToList()[0] as JObject;
-
-            // Get Common Capabilities
-            JObject commonCapabilities = config.GetValue("capabilities") as JObject;
-
-            // Merge Capabilities
-            capabilities.Merge(commonCapabilities);
-
-            JObject bstackOptions = capabilities["bstack:options"] as JObject;
-
-            // Get username and accesskey
-            string? username = Environment.GetEnvironmentVariable("BROWSERSTACK_USERNAME");
-            if (username is null)
-                username = config.GetValue("user").ToString();
-
-            string? accessKey = Environment.GetEnvironmentVariable("BROWSERSTACK_ACCESS_KEY");
-            if (accessKey is null)
-                accessKey = config.GetValue("key").ToString();
-
-            bstackOptions["userName"] = username;
-            bstackOptions["accessKey"] = accessKey;
-            
-            // Start Local if browserstack.local is set to true
-            if (profile.Equals("local") && accessKey is not null)
-            {
-                bstackOptions["local"] = true;
-                browserStackLocal = new Local();
-                List<KeyValuePair<string, string>> bsLocalArgs = new List<KeyValuePair<string, string>>() {
-                    new KeyValuePair<string, string>("key", accessKey)
-                };
-                foreach (var localOption in config.GetValue("localOptions") as JObject)
-                {
-                    if (localOption.Value is not null)
-                    {
-                        bsLocalArgs.Add(new KeyValuePair<string, string>(localOption.Key, localOption.Value.ToString()));
-                    }
-                }
-                browserStackLocal.start(bsLocalArgs);
-            }
-
-            capabilities["bstack:options"] = bstackOptions;
 
             // Create Desired Cappabilities for WebDriver
-            DriverOptions desiredCapabilities = getBrowserOption(capabilities.GetValue("browserName").ToString());
-            capabilities.Remove("browserName");
-            foreach (var x in capabilities)
-            {
-                if (x.Key.Equals("bstack:options"))
-                    desiredCapabilities.AddAdditionalOption(x.Key, x.Value.ToObject<Dictionary<string, object>>());
-                else
-                    desiredCapabilities.AddAdditionalOption(x.Key, x.Value);
-            }
+            DriverOptions desiredCapabilities = new OpenQA.Selenium.Chrome.ChromeOptions();
 
             // Create RemoteWebDriver instance
-            WebDriver = new RemoteWebDriver(new Uri($"https://{config["server"]}/wd/hub"), desiredCapabilities);
+            WebDriver = new RemoteWebDriver(new Uri($"http://localhost:4444/wd/hub"), desiredCapabilities);
 
             return WebDriver;
         }
 
-        public void SetStatus(bool passed)
-        {
-            if(WebDriver is not null)
-            {
-                if (passed)
-                    ((IJavaScriptExecutor)WebDriver).ExecuteScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\":\"passed\", \"reason\": \"Test Passed!\"}}");
-                else
-                    ((IJavaScriptExecutor)WebDriver).ExecuteScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\":\"failed\", \"reason\": \"Test Failed!\"}}");
-            }
-        }
-
-        static DriverOptions getBrowserOption(String browser)
-        {
-            switch (browser)
-            {
-                case "chrome":
-                    return new OpenQA.Selenium.Chrome.ChromeOptions();
-                case "firefox":
-                    return new OpenQA.Selenium.Firefox.FirefoxOptions();
-                case "safari":
-                    return new OpenQA.Selenium.Safari.SafariOptions();
-                case "edge":
-                    return new OpenQA.Selenium.Edge.EdgeOptions();
-                default:
-                    return new OpenQA.Selenium.Chrome.ChromeOptions();
-            }
-        }
-
         public void Dispose()
         {
             if (WebDriver is not null)
             {
                 WebDriver.Quit();
                 WebDriver.Dispose();
             }
-            if(browserStackLocal is not null)
-            {
-                browserStackLocal.stop();
-            }
         }
     }
 }

XUnit-BrowserStack/LocalTest.cs

@@ -0,0 +1,26 @@
+using Xunit;
+using OpenQA.Selenium.Remote;
+using System.Text.RegularExpressions;
+
+namespace XUnit_BrowserStack
+{
+    public class SampleLocalTest : IClassFixture<BaseFixture>
+    {
+
+        private readonly BaseFixture baseFixture;
+
+        public SampleLocalTest(BaseFixture baseFixture)
+        {
+            this.baseFixture = baseFixture;
+        }
+
+        [Fact]
+        [Trait("Category", "sample-local-test")]
+        public void BStackLocalTest()
+        {
+            RemoteWebDriver driver = baseFixture.GetDriver("chrome", "local");
+            driver.Navigate().GoToUrl("http://bs-local.com:45454/");
+            Assert.Contains("BrowserStack Local", driver.Title);
+        }
+    }
+}

XUnit-BrowserStack/ParallelTest.cs

@@ -0,0 +1,37 @@
+using Xunit;
+using OpenQA.Selenium;
+using OpenQA.Selenium.Remote;
+using OpenQA.Selenium.Support.UI;
+
+namespace XUnit_BrowserStack
+{
+    public class SampleTest : IClassFixture<BaseFixture>
+    {
+
+        private readonly BaseFixture baseFixture;
+
+        public SampleTest(BaseFixture baseFixture)
+        {
+            this.baseFixture = baseFixture;
+        }
+
+        [Fact]
+        [Trait("Category", "sample-test")]
+        public void BStackSampleTest()
+        {
+            RemoteWebDriver driver = baseFixture.GetDriver("chrome", "single");
+            WebDriverWait webDriverWait = new WebDriverWait(driver, TimeSpan.FromMilliseconds(2000));
+            driver.Manage().Window.Maximize();
+            driver.Navigate().GoToUrl("https://bstackdemo.com/");
+            Assert.Equal("StackDemo", driver.Title);
+
+            string productOnPageText = webDriverWait.Until(driver => driver.FindElement(By.XPath("//*[@id=\"1\"]/p"))).Text;
+
+            webDriverWait.Until(driver => driver.FindElement(By.XPath("//*[@id=\"1\"]/div[4]"))).Click();
+            bool cartOpened = webDriverWait.Until(driver => driver.FindElement(By.XPath("//*[@class=\"float-cart__content\"]"))).Displayed;
+            Assert.True(cartOpened);
+            string productOnCartText = webDriverWait.Until(driver => driver.FindElement(By.XPath("//*[@id=\"__next\"]/div/div/div[2]/div[2]/div[2]/div/div[3]/p[1]"))).Text;
+            Assert.Equal(productOnCartText, productOnPageText);
+        }
+    }
+}