Merge pull request #518 from mminns/issue/218

Issue/218

Author: mjcheetham

docs/configuration.md

@@ -196,6 +196,34 @@ git config --global credential.bitbucketAuthModes "oauth,basic"
 
 ---
 
+### credential.bitbucketAlwaysRefreshCredentials
+
+Forces GCM to ignore any existing stored Basic Auth or OAuth access tokens and always run through the process to refresh the credentials before returning them to Git.
+
+This is especially relevant to OAuth credentials. Bitbucket.org access tokens expire after 2 hours, after that the refresh token must be used to get a new access token.
+
+Enabling this option will improve performance when using Oauth2 and interacting with Bitbucket.org if, on average, commits are done less frequently than every 2 hours.
+
+Enabling this option will decrease performance when using Basic Auth by requiring the user the re-enter credentials everytime.
+
+
+Value|Refresh Credentials Before Returning
+-|-
+`true`, `1`, `yes`, `on` |Always
+`false`, `0`, `no`, `off`_(default)_|Only when the credentials are found to be invalid
+
+#### Example
+
+```shell
+git config --global credential.bitbucketAlwaysRefreshCredentials 1
+```
+
+Defaults to false/disabled.
+
+**Also see: [GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS](environment.md#GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS)**
+
+---
+
 ### credential.gitHubAuthModes
 
 Override the available authentication modes presented during GitHub authentication.

docs/environment.md

@@ -343,6 +343,40 @@ export GCM_BITBUCKET_AUTHMODES="oauth,basic"
 
 ---
 
+### GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS
+
+Forces GCM to ignore any existing stored Basic Auth or OAuth access tokens and always run through the process to refresh the credentials before returning them to Git.
+
+This is especially relevant to OAuth credentials. Bitbucket.org access tokens expire after 2 hours, after that the refresh token must be used to get a new access token.
+
+Enabling this option will improve performance when using Oauth2 and interacting with Bitbucket.org if, on average, commits are done less frequently than every 2 hours.
+
+Enabling this option will decrease performance when using Basic Auth by requiring the user the re-enter credentials everytime.
+
+
+Value|Refresh Credentials Before Returning
+-|-
+`true`, `1`, `yes`, `on` |Always
+`false`, `0`, `no`, `off`_(default)_|Only when the credentials are found to be invalid
+
+##### Windows
+
+```batch
+SET GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS=1
+```
+
+##### macOS/Linux
+
+```bash
+export GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS=1
+```
+
+Defaults to false/disabled.
+
+**Also see: [credential.bitbucketAlwaysRefreshCredentials](configuration.md#bitbucketAlwaysRefreshCredentials)**
+
+---
+
 ### GCM_GITHUB_AUTHMODES
 
 Override the available authentication modes presented during GitHub authentication.

src/shared/Atlassian.Bitbucket.Tests/BitbucketAuthenticationTest.cs

@@ -0,0 +1,43 @@
+using System;
+using System.Threading.Tasks;
+using GitCredentialManager.Tests.Objects;
+using Xunit;
+
+namespace Atlassian.Bitbucket.Tests
+{
+    public class BitbucketAuthenticationTest
+    {
+        [Theory]
+        [InlineData("jsquire", "password")]
+        public async Task BitbucketAuthentication_GetBasicCredentialsAsync_SucceedsAfterUserInput(string username, string password)
+        {
+            var context = new TestCommandContext();
+            context.Terminal.Prompts["Username"] = username;
+            context.Terminal.SecretPrompts["Password"] = password;
+            System.Uri targetUri = null;
+
+            var bitbucketAuthentication = new BitbucketAuthentication(context);
+
+            var result = await bitbucketAuthentication.GetBasicCredentialsAsync(targetUri, username);
+
+            Assert.NotNull(result);
+            Assert.Equal(username, result.Account);
+            Assert.Equal(password, result.Password);
+        }
+
+        [Fact]
+        public async Task BitbucketAuthentication_ShowOAuthRequiredPromptAsync_SucceedsAfterUserInput()
+        {
+            var context = new TestCommandContext();
+            context.Terminal.Prompts["Press enter to continue..."] = " ";
+
+            var bitbucketAuthentication = new BitbucketAuthentication(context);
+
+            var result = await bitbucketAuthentication.ShowOAuthRequiredPromptAsync();
+
+            Assert.True(result);
+            Assert.Equal($"Your account has two-factor authentication enabled.{Environment.NewLine}" +
+                                           $"To continue you must complete authentication in your web browser.{Environment.NewLine}", context.Terminal.Messages[0].Item1);
+        }
+    }
+}