Skip to content

Commit 83ce28e

Browse files
titusfortnertitusfortner
authored
[dotnet] implement file downloads (#12981)
1 parent af1af0b commit 83ce28e

File tree

8 files changed

+273
-4
lines changed

8 files changed

+273
-4
lines changed

‎dotnet/src/webdriver/CapabilityType.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,11 @@ public static class CapabilityType
161161
/// </summary>
162162
public static readonly string WebSocketUrl = "webSocketUrl";
163163

164+
/// <summary>
165+
/// Capability name used to get a value indicating whether files may be downloaded from remote end.
166+
/// </summary>
167+
public static readonly string EnableDownloads = "se:downloadsEnabled";
168+
164169
private static readonly List<string> KnownSpecCompliantCapabilityNames = new List<string>() {
165170
BrowserName,
166171
BrowserVersion,

‎dotnet/src/webdriver/DriverCommand.cs‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,21 @@ public static class DriverCommand
393393
/// </summary>
394394
public static readonly string SetUserVerified = "setUserVerified";
395395

396+
/// <summary>
397+
/// Represents the GetDownloadableFiles command.
398+
/// </summary>
399+
public static readonly string GetDownloadableFiles = "getDownloadableFiles";
400+
401+
/// <summary>
402+
/// Represents the DownloadFile command.
403+
/// </summary>
404+
public static readonly string DownloadFile = "downloadFile";
405+
406+
/// <summary>
407+
/// Represents the DeleteDownloadableFiles command.
408+
/// </summary>
409+
public static readonly string DeleteDownloadableFiles = "deleteDownloadableFiles";
410+
396411
/// <summary>
397412
/// Lists the set of known commands valid for the Selenium library.
398413
/// </summary>
@@ -468,7 +483,10 @@ public static class DriverCommand
468483
GetCredentials,
469484
RemoveCredential,
470485
RemoveAllCredentials,
471-
SetUserVerified
486+
SetUserVerified,
487+
GetDownloadableFiles,
488+
DownloadFile,
489+
DeleteDownloadableFiles
472490
}.AsReadOnly();
473491
}
474492
}

‎dotnet/src/webdriver/DriverOptions.cs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ public abstract class DriverOptions
101101
private bool? acceptInsecureCertificates;
102102
private bool? useWebSocketUrl;
103103
private bool useStrictFileInteractability;
104+
private bool? enableDownloads;
104105
private UnhandledPromptBehavior unhandledPromptBehavior = UnhandledPromptBehavior.Default;
105106
private PageLoadStrategy pageLoadStrategy = PageLoadStrategy.Default;
106107
private Dictionary<string, object> additionalCapabilities = new Dictionary<string, object>();
@@ -120,6 +121,7 @@ protected DriverOptions()
120121
this.AddKnownCapabilityName(CapabilityType.PageLoadStrategy, "PageLoadStrategy property");
121122
this.AddKnownCapabilityName(CapabilityType.UseStrictFileInteractability, "UseStrictFileInteractability property");
122123
this.AddKnownCapabilityName(CapabilityType.WebSocketUrl, "UseWebSocketUrl property");
124+
this.AddKnownCapabilityName(CapabilityType.EnableDownloads, "EnableDownloads property");
123125
}
124126

125127
/// <summary>
@@ -208,6 +210,15 @@ public bool UseStrictFileInteractability
208210
set { this.useStrictFileInteractability = value; }
209211
}
210212

213+
/// <summary>
214+
/// Gets or sets a value indicating whether files may be downloaded from remote node.
215+
/// </summary>
216+
public bool? EnableDownloads
217+
{
218+
get { return this.enableDownloads; }
219+
set { this.enableDownloads = value; }
220+
}
221+
211222
/// <summary>
212223
/// Set or Get the location of the browser
213224
/// Override in subclass
@@ -460,6 +471,11 @@ protected IWritableCapabilities GenerateDesiredCapabilities(bool isSpecification
460471
capabilities.SetCapability(CapabilityType.WebSocketUrl, this.useWebSocketUrl);
461472
}
462473

474+
if (this.enableDownloads.HasValue)
475+
{
476+
capabilities.SetCapability(CapabilityType.EnableDownloads, this.enableDownloads);
477+
}
478+
463479
if (this.useStrictFileInteractability)
464480
{
465481
capabilities.SetCapability(CapabilityType.UseStrictFileInteractability, true);

‎dotnet/src/webdriver/IHasDownloads.cs‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// <copyright file="IHasSessionId.cs" company="WebDriver Committers">
2+
// Licensed to the Software Freedom Conservancy (SFC) under one
3+
// or more contributor license agreements. See the NOTICE file
4+
// distributed with this work for additional information
5+
// regarding copyright ownership. The SFC licenses this file
6+
// to you under the Apache License, Version 2.0 (the "License");
7+
// you may not use this file except in compliance with the License.
8+
// You may obtain a copy of the License at
9+
//
10+
// http://www.apache.org/licenses/LICENSE-2.0
11+
//
12+
// Unless required by applicable law or agreed to in writing, software
13+
// distributed under the License is distributed on an "AS IS" BASIS,
14+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
// See the License for the specific language governing permissions and
16+
// limitations under the License.
17+
// </copyright>
18+
19+
namespace OpenQA.Selenium
20+
{
21+
using System.Collections.Generic;
22+
23+
using System.Collections.Generic;
24+
25+
/// <summary>
26+
/// Interface indicating the driver can handle downloading remote files.
27+
/// </summary>
28+
public interface IHasDownloads
29+
{
30+
/// <summary>
31+
/// Retrieves the downloadable files.
32+
/// </summary>
33+
/// <returns>A list of file names available for download.</returns>
34+
List<string> GetDownloadableFiles();
35+
36+
/// <summary>
37+
/// Downloads a file with the specified file name and returns a dictionary containing the downloaded file's data.
38+
/// </summary>
39+
/// <param name="fileName">The name of the file to be downloaded.</param>
40+
/// <param name="targetDirectory">The location to save the downloaded file.</param>
41+
void DownloadFile(string fileName, string targetDirectory);
42+
43+
/// <summary>
44+
/// Deletes the downloadable files.
45+
/// </summary>
46+
void DeleteDownloadableFiles();
47+
}}

‎dotnet/src/webdriver/Remote/RemoteWebDriver.cs‎

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@
1919
using System;
2020
using System.Collections.Generic;
2121
using System.Collections.ObjectModel;
22+
using System.IO;
23+
using System.IO.Compression;
24+
using System.Linq;
2225
using System.Threading.Tasks;
2326
using OpenQA.Selenium.DevTools;
24-
using OpenQA.Selenium.Internal;
2527

2628
namespace OpenQA.Selenium.Remote
2729
{
@@ -58,7 +60,7 @@ namespace OpenQA.Selenium.Remote
5860
/// }
5961
/// </code>
6062
/// </example>
61-
public class RemoteWebDriver : WebDriver, IDevTools
63+
public class RemoteWebDriver : WebDriver, IDevTools, IHasDownloads
6264
{
6365
/// <summary>
6466
/// The name of the Selenium grid remote DevTools end point capability.
@@ -468,6 +470,73 @@ public DevToolsSession GetDevToolsSession(int protocolVersion)
468470
return this.devToolsSession;
469471
}
470472

473+
/// <summary>
474+
/// Retrieves the downloadable files as a map of file names and their corresponding URLs.
475+
/// </summary>
476+
/// <returns>A list containing file names as keys and URLs as values.</returns>
477+
public List<string> GetDownloadableFiles()
478+
{
479+
var enableDownloads = this.Capabilities.GetCapability(CapabilityType.EnableDownloads);
480+
if (enableDownloads == null || !(bool) enableDownloads) {
481+
throw new WebDriverException("You must enable downloads in order to work with downloadable files.");
482+
}
483+
484+
Response commandResponse = this.Execute(DriverCommand.GetDownloadableFiles, null);
485+
Dictionary<string, object> value = (Dictionary<string, object>)commandResponse.Value;
486+
object[] namesArray = (object[])value["names"];
487+
return namesArray.Select(obj => obj.ToString()).ToList();
488+
}
489+
490+
/// <summary>
491+
/// Downloads a file with the specified file name.
492+
/// </summary>
493+
/// <param name="fileName">the name of the file to be downloaded</param>
494+
public void DownloadFile(string fileName, string targetDirectory)
495+
{
496+
var enableDownloads = this.Capabilities.GetCapability(CapabilityType.EnableDownloads);
497+
if (enableDownloads == null || !(bool) enableDownloads) {
498+
throw new WebDriverException("You must enable downloads in order to work with downloadable files.");
499+
}
500+
501+
Dictionary<string, object> parameters = new Dictionary<string, object>
502+
{
503+
{ "name", fileName }
504+
};
505+
506+
Response commandResponse = this.Execute(DriverCommand.DownloadFile, parameters);
507+
string contents = ((Dictionary<string, object>)commandResponse.Value)["contents"].ToString();
508+
byte[] fileData = Convert.FromBase64String(contents);
509+
510+
Directory.CreateDirectory(targetDirectory);
511+
string tempFile = Path.Combine(targetDirectory, "temp.zip");
512+
File.WriteAllBytes(tempFile, fileData);
513+
514+
using (ZipArchive archive = ZipFile.OpenRead(tempFile))
515+
{
516+
foreach (ZipArchiveEntry entry in archive.Entries)
517+
{
518+
string destinationPath = Path.Combine(targetDirectory, entry.FullName);
519+
520+
entry.ExtractToFile(destinationPath);
521+
}
522+
}
523+
524+
File.Delete(tempFile);
525+
}
526+
527+
/// <summary>
528+
/// Deletes all downloadable files.
529+
/// </summary>
530+
public void DeleteDownloadableFiles()
531+
{
532+
var enableDownloads = this.Capabilities.GetCapability(CapabilityType.EnableDownloads);
533+
if (enableDownloads == null || !(bool) enableDownloads) {
534+
throw new WebDriverException("You must enable downloads in order to work with downloadable files.");
535+
}
536+
537+
this.Execute(DriverCommand.DeleteDownloadableFiles, null);
538+
}
539+
471540
/// <summary>
472541
/// Closes a DevTools session.
473542
/// </summary>

‎dotnet/src/webdriver/Remote/W3CWireProtocolCommandInfoRepository.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ protected override void InitializeCommandDictionary()
134134
this.TryAddCommand(DriverCommand.IsElementDisplayed, new HttpCommandInfo(HttpCommandInfo.GetCommand, "/session/{sessionId}/element/{id}/displayed"));
135135
this.TryAddCommand(DriverCommand.ElementEquals, new HttpCommandInfo(HttpCommandInfo.GetCommand, "/session/{sessionId}/element/{id}/equals/{other}"));
136136
this.TryAddCommand(DriverCommand.UploadFile, new HttpCommandInfo(HttpCommandInfo.PostCommand, "/session/{sessionId}/se/file"));
137+
this.TryAddCommand(DriverCommand.GetDownloadableFiles, new HttpCommandInfo(HttpCommandInfo.GetCommand, "/session/{sessionId}/se/files"));
138+
this.TryAddCommand(DriverCommand.DownloadFile, new HttpCommandInfo(HttpCommandInfo.PostCommand, "/session/{sessionId}/se/files"));
139+
this.TryAddCommand(DriverCommand.DeleteDownloadableFiles, new HttpCommandInfo(HttpCommandInfo.DeleteCommand, "/session/{sessionId}/se/files"));
137140
}
138141
}
139142
}

‎dotnet/test/common/DownloadsTest.cs‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
using NUnit.Framework;
2+
using OpenQA.Selenium;
3+
using OpenQA.Selenium.Environment;
4+
using System.Collections.Generic;
5+
using System;
6+
using System.IO;
7+
using System.IO.Compression;
8+
using System.Linq;
9+
using OpenQA.Selenium.Remote;
10+
using OpenQA.Selenium.Support.UI;
11+
12+
namespace OpenQA.Selenium
13+
{
14+
[TestFixture]
15+
public class DownLoadsTest : DriverTestFixture
16+
{
17+
private IWebDriver localDriver;
18+
19+
[SetUp]
20+
public void ResetDriver()
21+
{
22+
EnvironmentManager.Instance.CloseCurrentDriver();
23+
InitLocalDriver();
24+
}
25+
26+
[TearDown]
27+
public void QuitAdditionalDriver()
28+
{
29+
if (localDriver != null)
30+
{
31+
localDriver.Quit();
32+
localDriver = null;
33+
}
34+
35+
EnvironmentManager.Instance.CreateFreshDriver();
36+
}
37+
38+
[Test]
39+
[Ignore("Needs to run with Remote WebDriver")]
40+
public void CanListDownloadableFiles()
41+
{
42+
DownloadWithBrowser();
43+
44+
List<string> names = ((RemoteWebDriver) driver).GetDownloadableFiles();
45+
Assert.That(names, Contains.Item("file_1.txt"));
46+
Assert.That(names, Contains.Item("file_2.jpg"));
47+
}
48+
49+
[Test]
50+
[Ignore("Needs to run with Remote WebDriver")]
51+
public void CanDownloadFile()
52+
{
53+
DownloadWithBrowser();
54+
55+
List<string> names = ((RemoteWebDriver) driver).GetDownloadableFiles();
56+
string fileName = names[0];
57+
string targetDirectory = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
58+
59+
((RemoteWebDriver) driver).DownloadFile(fileName, targetDirectory);
60+
61+
string fileContent = File.ReadAllText(Path.Combine(targetDirectory, fileName));
62+
Assert.AreEqual("Hello, World!", fileContent.Trim());
63+
64+
Directory.Delete(targetDirectory, recursive: true);
65+
}
66+
67+
[Test]
68+
[Ignore("Needs to run with Remote WebDriver")]
69+
public void CanDeleteFiles()
70+
{
71+
DownloadWithBrowser();
72+
73+
((RemoteWebDriver)driver).DeleteDownloadableFiles();
74+
75+
List<string> names = ((RemoteWebDriver) driver).GetDownloadableFiles();
76+
Assert.IsEmpty(names, "The names list should be empty.");
77+
}
78+
79+
private void DownloadWithBrowser()
80+
{
81+
string downloadPage = EnvironmentManager.Instance.UrlBuilder.WhereIs("downloads/download.html");
82+
localDriver.Url = downloadPage;
83+
driver.FindElement(By.Id("file-1")).Click();
84+
driver.FindElement(By.Id("file-2")).Click();
85+
86+
WebDriverWait wait = new WebDriverWait(driver, TimeSpan.FromSeconds(3));
87+
wait.Until(d => ((RemoteWebDriver) d).GetDownloadableFiles().Contains("file_2.jpg"));
88+
}
89+
90+
private void InitLocalDriver()
91+
{
92+
DownloadableFilesOptions options = new DownloadableFilesOptions();
93+
options.EnableDownloads = true;
94+
95+
localDriver = EnvironmentManager.Instance.CreateDriverInstance(options);
96+
}
97+
98+
public class DownloadableFilesOptions : DriverOptions
99+
{
100+
public override void AddAdditionalOption(string capabilityName, object capabilityValue)
101+
{
102+
}
103+
104+
public override ICapabilities ToCapabilities()
105+
{
106+
return null;
107+
}
108+
}
109+
}
110+
}
111+

‎dotnet/test/common/Environment/RemoteSeleniumServer.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public void Start()
3434

3535
webserverProcess = new Process();
3636
webserverProcess.StartInfo.FileName = "java.exe";
37-
webserverProcess.StartInfo.Arguments = " -jar " + serverJarName + " standalone --port 6000 --selenium-manager true";
37+
webserverProcess.StartInfo.Arguments = " -jar " + serverJarName + " standalone --port 6000 --selenium-manager true --enable-managed-downloads true";
3838
webserverProcess.StartInfo.WorkingDirectory = projectRootPath;
3939
webserverProcess.Start();
4040
DateTime timeout = DateTime.Now.Add(TimeSpan.FromSeconds(30));

0 commit comments

Comments
 (0)