|
| 1 | +// Licensed to the Software Freedom Conservancy (SFC) under one |
| 2 | +// or more contributor license agreements. See the NOTICE file |
| 3 | +// distributed with this work for additional information |
| 4 | +// regarding copyright ownership. The SFC licenses this file |
| 5 | +// to you under the Apache License, Version 2.0 (the |
| 6 | +// "License"); you may not use this file except in compliance |
| 7 | +// with the License. You may obtain a copy of the License at |
| 8 | +// |
| 9 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +// |
| 11 | +// Unless required by applicable law or agreed to in writing, |
| 12 | +// software distributed under the License is distributed on an |
| 13 | +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +// KIND, either express or implied. See the License for the |
| 15 | +// specific language governing permissions and limitations |
| 16 | +// under the License. |
| 17 | + |
| 18 | +use crate::config::ManagerConfig; |
| 19 | +use reqwest::Client; |
| 20 | +use std::collections::HashMap; |
| 21 | +use std::error::Error; |
| 22 | +use std::path::PathBuf; |
| 23 | + |
| 24 | +use crate::files::{get_cache_folder, BrowserPath}; |
| 25 | + |
| 26 | +use crate::downloads::parse_json_from_url; |
| 27 | +use crate::{create_http_client, parse_version, Logger, SeleniumManager, SNAPSHOT}; |
| 28 | + |
| 29 | +use crate::metadata::{ |
| 30 | + create_driver_metadata, get_driver_version_from_metadata, get_metadata, write_metadata, |
| 31 | +}; |
| 32 | +use crate::mirror::{Assets, SeleniumRelease, MIRROR_URL}; |
| 33 | + |
| 34 | +pub const GRID_NAME: &str = "grid"; |
| 35 | +const GRID_RELEASE: &str = "selenium-server"; |
| 36 | +const GRID_EXTENSION: &str = "jar"; |
| 37 | +const DRIVER_URL: &str = "https://github.com/SeleniumHQ/selenium/releases/"; |
| 38 | + |
| 39 | +// Although Selenium Grid is not a browser, we can use the same manager struct, where: |
| 40 | +// - browser_name refers to the product name, i.e., grid |
| 41 | +// - driver_name refers to the downloadable artifact, i.e., selenium-server (.jar) |
| 42 | +pub struct GridManager { |
| 43 | + pub browser_name: &'static str, |
| 44 | + pub driver_name: &'static str, |
| 45 | + pub config: ManagerConfig, |
| 46 | + pub http_client: Client, |
| 47 | + pub log: Logger, |
| 48 | + pub driver_url: Option<String>, |
| 49 | +} |
| 50 | + |
| 51 | +impl GridManager { |
| 52 | + pub fn new(driver_version: String) -> Result<Box<Self>, Box<dyn Error>> { |
| 53 | + let browser_name = GRID_NAME; |
| 54 | + let driver_name = GRID_RELEASE; |
| 55 | + let mut config = ManagerConfig::default(browser_name, driver_name); |
| 56 | + config.driver_version = driver_version; |
| 57 | + let default_timeout = config.timeout.to_owned(); |
| 58 | + let default_proxy = &config.proxy; |
| 59 | + Ok(Box::new(GridManager { |
| 60 | + browser_name, |
| 61 | + driver_name, |
| 62 | + http_client: create_http_client(default_timeout, default_proxy)?, |
| 63 | + config, |
| 64 | + log: Logger::default(), |
| 65 | + driver_url: None, |
| 66 | + })) |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +impl SeleniumManager for GridManager { |
| 71 | + fn get_browser_name(&self) -> &str { |
| 72 | + self.browser_name |
| 73 | + } |
| 74 | + |
| 75 | + fn get_http_client(&self) -> &Client { |
| 76 | + &self.http_client |
| 77 | + } |
| 78 | + |
| 79 | + fn set_http_client(&mut self, http_client: Client) { |
| 80 | + self.http_client = http_client; |
| 81 | + } |
| 82 | + |
| 83 | + fn get_browser_path_map(&self) -> HashMap<BrowserPath, &str> { |
| 84 | + HashMap::new() |
| 85 | + } |
| 86 | + |
| 87 | + fn discover_browser_version(&self) -> Option<String> { |
| 88 | + None |
| 89 | + } |
| 90 | + |
| 91 | + fn get_driver_name(&self) -> &str { |
| 92 | + self.driver_name |
| 93 | + } |
| 94 | + |
| 95 | + fn request_driver_version(&mut self) -> Result<String, Box<dyn Error>> { |
| 96 | + let browser_version_binding = self.get_major_browser_version(); |
| 97 | + let browser_version = browser_version_binding.as_str(); |
| 98 | + let mut metadata = get_metadata(self.get_logger()); |
| 99 | + |
| 100 | + match get_driver_version_from_metadata(&metadata.drivers, self.driver_name, browser_version) |
| 101 | + { |
| 102 | + Some(driver_version) => { |
| 103 | + self.log.trace(format!( |
| 104 | + "Driver TTL is valid. Getting {} version from metadata", |
| 105 | + &self.driver_name |
| 106 | + )); |
| 107 | + Ok(driver_version) |
| 108 | + } |
| 109 | + _ => { |
| 110 | + let selenium_releases = parse_json_from_url::<Vec<SeleniumRelease>>( |
| 111 | + self.get_http_client(), |
| 112 | + MIRROR_URL.to_string(), |
| 113 | + )?; |
| 114 | + |
| 115 | + let filtered_releases: Vec<SeleniumRelease> = selenium_releases |
| 116 | + .into_iter() |
| 117 | + .filter(|r| { |
| 118 | + r.assets.iter().any(|url| { |
| 119 | + url.browser_download_url.contains(GRID_RELEASE) |
| 120 | + && !url.browser_download_url.contains(SNAPSHOT) |
| 121 | + }) |
| 122 | + }) |
| 123 | + .collect(); |
| 124 | + |
| 125 | + if !filtered_releases.is_empty() { |
| 126 | + let assets = &filtered_releases.get(0).unwrap().assets; |
| 127 | + let driver_releases: Vec<&Assets> = assets |
| 128 | + .iter() |
| 129 | + .filter(|url| { |
| 130 | + url.browser_download_url.contains(GRID_RELEASE) |
| 131 | + && url.browser_download_url.contains(GRID_EXTENSION) |
| 132 | + }) |
| 133 | + .collect(); |
| 134 | + let driver_url = &driver_releases.last().unwrap().browser_download_url; |
| 135 | + self.driver_url = Some(driver_url.to_string()); |
| 136 | + |
| 137 | + let index_release = |
| 138 | + driver_url.rfind(GRID_RELEASE).unwrap() + GRID_RELEASE.len() + 1; |
| 139 | + let driver_version = parse_version( |
| 140 | + driver_url.as_str()[index_release..].to_string(), |
| 141 | + self.get_logger(), |
| 142 | + )?; |
| 143 | + |
| 144 | + let driver_ttl = self.get_driver_ttl(); |
| 145 | + if driver_ttl > 0 { |
| 146 | + metadata.drivers.push(create_driver_metadata( |
| 147 | + browser_version, |
| 148 | + self.driver_name, |
| 149 | + &driver_version, |
| 150 | + driver_ttl, |
| 151 | + )); |
| 152 | + write_metadata(&metadata, self.get_logger()); |
| 153 | + } |
| 154 | + |
| 155 | + Ok(driver_version) |
| 156 | + } else { |
| 157 | + Err(format!("{} release not available", self.get_driver_name()).into()) |
| 158 | + } |
| 159 | + } |
| 160 | + } |
| 161 | + } |
| 162 | + |
| 163 | + fn get_driver_url(&mut self) -> Result<String, Box<dyn Error>> { |
| 164 | + if self.driver_url.is_some() { |
| 165 | + return Ok(self.driver_url.as_ref().unwrap().to_string()); |
| 166 | + } |
| 167 | + |
| 168 | + let release_version = self.get_selenium_release_version()?; |
| 169 | + Ok(format!( |
| 170 | + "{}download/{}/{}-{}.{}", |
| 171 | + DRIVER_URL, |
| 172 | + release_version, |
| 173 | + GRID_RELEASE, |
| 174 | + self.get_driver_version(), |
| 175 | + GRID_EXTENSION |
| 176 | + )) |
| 177 | + } |
| 178 | + |
| 179 | + fn get_driver_path_in_cache(&self) -> PathBuf { |
| 180 | + let browser_name = self.get_browser_name(); |
| 181 | + let driver_name = self.get_driver_name(); |
| 182 | + let driver_version = self.get_driver_version(); |
| 183 | + get_cache_folder() |
| 184 | + .join(browser_name) |
| 185 | + .join(driver_version) |
| 186 | + .join(format!("{driver_name}-{driver_version}.{GRID_EXTENSION}")) |
| 187 | + } |
| 188 | + |
| 189 | + fn get_config(&self) -> &ManagerConfig { |
| 190 | + &self.config |
| 191 | + } |
| 192 | + |
| 193 | + fn get_config_mut(&mut self) -> &mut ManagerConfig { |
| 194 | + &mut self.config |
| 195 | + } |
| 196 | + |
| 197 | + fn set_config(&mut self, config: ManagerConfig) { |
| 198 | + self.config = config; |
| 199 | + } |
| 200 | + |
| 201 | + fn get_logger(&self) -> &Logger { |
| 202 | + &self.log |
| 203 | + } |
| 204 | + |
| 205 | + fn set_logger(&mut self, log: Logger) { |
| 206 | + self.log = log; |
| 207 | + } |
| 208 | +} |
0 commit comments