diff options
Diffstat (limited to 'crates/shirabe/tests/util/bitbucket_test.rs')
| -rw-r--r-- | crates/shirabe/tests/util/bitbucket_test.rs | 640 |
1 files changed, 600 insertions, 40 deletions
diff --git a/crates/shirabe/tests/util/bitbucket_test.rs b/crates/shirabe/tests/util/bitbucket_test.rs index 3e3fad8..d57a49a 100644 --- a/crates/shirabe/tests/util/bitbucket_test.rs +++ b/crates/shirabe/tests/util/bitbucket_test.rs @@ -1,100 +1,660 @@ //! ref: composer/tests/Composer/Test/Util/BitbucketTest.php -// These mock IO/Config/HttpDownloader to drive Bitbucket's OAuth/access-token flow; mocking -// is not available and a real HttpDownloader reaches curl_multi_init (todo!()). +use std::cell::RefCell; +use std::rc::Rc; -#[allow(dead_code)] -fn set_up() { - // Builds mocked IO/HttpDownloader/Config and records time(); mocking is not available. - todo!() +use indexmap::IndexMap; +use shirabe::config::{Config, ConfigSourceInterface}; +use shirabe::io::IOInterface; +use shirabe::io::io_interface; +use shirabe::util::Bitbucket; +use shirabe::util::http_downloader::{ + HttpDownloader, HttpDownloaderMockExpectation, HttpDownloaderMockHandler, +}; +use shirabe::util::process_executor::MockHandler; +use shirabe_php_shim::{PhpMixed, time}; + +use crate::config_stub::ConfigStubBuilder; +use crate::http_downloader_mock::{expect_full, get_http_downloader_mock}; +use crate::io_mock::{Expectation, IOMock, get_io_mock}; +use crate::process_executor_mock::get_process_executor_mock; + +const USERNAME: &str = "username"; +const PASSWORD: &str = "password"; +const CONSUMER_KEY: &str = "consumer_key"; +const CONSUMER_SECRET: &str = "consumer_secret"; +const MESSAGE: &str = "mymessage"; +const ORIGIN: &str = "bitbucket.org"; +const TOKEN: &str = "bitbuckettoken"; + +// Records add/removeConfigSetting calls and serves a configurable getName, mirroring +// the PHPUnit mock of ConfigSourceInterface used throughout BitbucketTest. +#[derive(Debug, Clone, Default)] +struct ConfigSourceCalls { + added: Vec<(String, PhpMixed)>, + removed: Vec<String>, +} + +#[derive(Debug)] +struct ConfigSourceMock { + name: String, + calls: Rc<RefCell<ConfigSourceCalls>>, +} + +impl ConfigSourceInterface for ConfigSourceMock { + fn add_repository( + &mut self, + _name: &str, + _config: PhpMixed, + _append: bool, + ) -> anyhow::Result<()> { + unreachable!() + } + fn insert_repository( + &mut self, + _name: &str, + _config: PhpMixed, + _reference_name: &str, + _offset: i64, + ) -> anyhow::Result<()> { + unreachable!() + } + fn set_repository_url(&mut self, _name: &str, _url: &str) -> anyhow::Result<()> { + unreachable!() + } + fn remove_repository(&mut self, _name: &str) -> anyhow::Result<()> { + unreachable!() + } + fn add_config_setting(&mut self, name: &str, value: PhpMixed) -> anyhow::Result<()> { + self.calls + .borrow_mut() + .added + .push((name.to_string(), value)); + Ok(()) + } + fn remove_config_setting(&mut self, name: &str) -> anyhow::Result<()> { + self.calls.borrow_mut().removed.push(name.to_string()); + Ok(()) + } + fn add_property(&mut self, _name: &str, _value: PhpMixed) -> anyhow::Result<()> { + unreachable!() + } + fn remove_property(&mut self, _name: &str) -> anyhow::Result<()> { + unreachable!() + } + fn add_link(&mut self, _type: &str, _name: &str, _value: &str) -> anyhow::Result<()> { + unreachable!() + } + fn remove_link(&mut self, _type: &str, _name: &str) -> anyhow::Result<()> { + unreachable!() + } + fn get_name(&self) -> String { + self.name.clone() + } +} + +// Mirrors BitbucketTest::setUp: a DEBUG-verbosity IOMock, a mocked HttpDownloader, a +// real Config, the captured `time()`, and the Bitbucket under test. The mock guards +// run their assert_complete on drop at the end of the test scope. +struct Fixture { + io: Rc<RefCell<IOMock>>, + config: Rc<RefCell<Config>>, + http_downloader: Rc<RefCell<HttpDownloader>>, + time: i64, + bitbucket: Bitbucket, + _io_guard: crate::io_mock::IOMockGuard, + _http_guard: crate::http_downloader_mock::HttpDownloaderMockGuard, +} + +fn set_up_with_config_and_http( + config: Rc<RefCell<Config>>, + http_expectations: Vec<HttpDownloaderMockExpectation>, +) -> Fixture { + let (io_mock, io_guard) = get_io_mock(io_interface::DEBUG).unwrap(); + let (http_downloader, http_guard) = get_http_downloader_mock( + http_expectations, + true, + HttpDownloaderMockHandler::default(), + ); + + let io: Rc<RefCell<dyn IOInterface>> = io_mock.clone(); + let time = time(); + let bitbucket = Bitbucket::new( + io, + config.clone(), + None, + Some(http_downloader.clone()), + Some(time), + ) + .unwrap(); + + Fixture { + io: io_mock, + config, + http_downloader, + time, + bitbucket, + _io_guard: io_guard, + _http_guard: http_guard, + } +} + +// The OAuth2 token request as built by Bitbucket::request_access_token. +fn access_token_request_options() -> IndexMap<String, PhpMixed> { + let mut http = IndexMap::new(); + http.insert("method".to_string(), PhpMixed::String("POST".to_string())); + http.insert( + "content".to_string(), + PhpMixed::String("grant_type=client_credentials".to_string()), + ); + let mut options: IndexMap<String, PhpMixed> = IndexMap::new(); + options.insert("retry-auth-failure".to_string(), PhpMixed::Bool(false)); + options.insert("http".to_string(), PhpMixed::Array(http)); + options +} + +fn access_token_body() -> String { + format!( + "{{\"access_token\": \"{}\", \"scopes\": \"repository\", \"expires_in\": 3600, \"refresh_token\": \"refreshtoken\", \"token_type\": \"bearer\"}}", + TOKEN + ) +} + +// Installs recording config/auth config sources and returns their shared call logs, +// mirroring BitbucketTest::setExpectationsForStoringAccessToken. +struct StoreAccessTokenMocks { + config_source: Rc<RefCell<ConfigSourceCalls>>, + auth_config_source: Rc<RefCell<ConfigSourceCalls>>, +} + +fn set_expectations_for_storing_access_token( + config: &Rc<RefCell<Config>>, +) -> StoreAccessTokenMocks { + let config_source = Rc::new(RefCell::new(ConfigSourceCalls::default())); + let auth_config_source = Rc::new(RefCell::new(ConfigSourceCalls::default())); + config + .borrow_mut() + .set_config_source(Box::new(ConfigSourceMock { + name: "config-source".to_string(), + calls: config_source.clone(), + })); + config + .borrow_mut() + .set_auth_config_source(Box::new(ConfigSourceMock { + name: "auth-config-source".to_string(), + calls: auth_config_source.clone(), + })); + StoreAccessTokenMocks { + config_source, + auth_config_source, + } +} + +fn expected_stored_token(time: i64) -> PhpMixed { + let mut consumer = IndexMap::new(); + consumer.insert( + "consumer-key".to_string(), + PhpMixed::String(CONSUMER_KEY.to_string()), + ); + consumer.insert( + "consumer-secret".to_string(), + PhpMixed::String(CONSUMER_SECRET.to_string()), + ); + consumer.insert( + "access-token".to_string(), + PhpMixed::String(TOKEN.to_string()), + ); + consumer.insert( + "access-token-expiration".to_string(), + PhpMixed::Int(time + 3600), + ); + PhpMixed::Array(consumer) +} + +fn assert_stored_access_token(mocks: &StoreAccessTokenMocks, time: i64, remove_basic_auth: bool) { + assert_eq!( + mocks.config_source.borrow().removed, + vec![format!("bitbucket-oauth.{}", ORIGIN)], + ); + assert_eq!( + mocks.auth_config_source.borrow().added, + vec![( + format!("bitbucket-oauth.{}", ORIGIN), + expected_stored_token(time) + )], + ); + if remove_basic_auth { + assert_eq!( + mocks.auth_config_source.borrow().removed, + vec![format!("http-basic.{}", ORIGIN)], + ); + } } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_request_access_token_with_valid_oauth_consumer() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let mut f = set_up_with_config_and_http( + config, + vec![expect_full( + Bitbucket::OAUTH2_ACCESS_TOKEN_URL, + Some(access_token_request_options()), + 200, + access_token_body(), + vec![], + )], + ); + + f.io.borrow_mut() + .expects( + vec![Expectation::auth( + ORIGIN, + CONSUMER_KEY, + Some(CONSUMER_SECRET.to_string()), + )], + false, + ) + .unwrap(); + + let mocks = set_expectations_for_storing_access_token(&f.config); + + assert_eq!( + f.bitbucket + .request_token(ORIGIN, CONSUMER_KEY, CONSUMER_SECRET) + .unwrap(), + TOKEN + ); + + assert_stored_access_token(&mocks, f.time, false); } #[test] -#[ignore = "needs getMockBuilder mock for Config (no mock infrastructure)"] fn test_request_access_token_with_valid_oauth_consumer_and_valid_stored_access_token() { - todo!() + let time = time(); + let mut stored = IndexMap::new(); + stored.insert( + "access-token".to_string(), + PhpMixed::String(TOKEN.to_string()), + ); + stored.insert( + "access-token-expiration".to_string(), + PhpMixed::Int(time + 1800), + ); + stored.insert( + "consumer-key".to_string(), + PhpMixed::String(CONSUMER_KEY.to_string()), + ); + stored.insert( + "consumer-secret".to_string(), + PhpMixed::String(CONSUMER_SECRET.to_string()), + ); + let mut oauth = IndexMap::new(); + oauth.insert(ORIGIN.to_string(), PhpMixed::Array(stored)); + + let config = ConfigStubBuilder::new() + .with("bitbucket-oauth", PhpMixed::Array(oauth)) + .build_shared(); + let mut f = set_up_with_config_and_http(config, vec![]); + f.time = time; + + assert_eq!( + f.bitbucket + .request_token(ORIGIN, CONSUMER_KEY, CONSUMER_SECRET) + .unwrap(), + TOKEN + ); + + // testGetTokenWithAccessToken (@depends): the same Bitbucket now returns the token. + assert_eq!(f.bitbucket.get_token(), TOKEN); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_request_access_token_with_valid_oauth_consumer_and_expired_access_token() { - todo!() + let time = time(); + let mut stored = IndexMap::new(); + stored.insert( + "access-token".to_string(), + PhpMixed::String("randomExpiredToken".to_string()), + ); + stored.insert( + "access-token-expiration".to_string(), + PhpMixed::Int(time - 400), + ); + stored.insert( + "consumer-key".to_string(), + PhpMixed::String(CONSUMER_KEY.to_string()), + ); + stored.insert( + "consumer-secret".to_string(), + PhpMixed::String(CONSUMER_SECRET.to_string()), + ); + let mut oauth = IndexMap::new(); + oauth.insert(ORIGIN.to_string(), PhpMixed::Array(stored)); + + let config = ConfigStubBuilder::new() + .with("bitbucket-oauth", PhpMixed::Array(oauth)) + .build_shared(); + let mut f = set_up_with_config_and_http( + config, + vec![expect_full( + Bitbucket::OAUTH2_ACCESS_TOKEN_URL, + Some(access_token_request_options()), + 200, + access_token_body(), + vec![], + )], + ); + f.time = time; + + f.io.borrow_mut() + .expects( + vec![Expectation::auth( + ORIGIN, + CONSUMER_KEY, + Some(CONSUMER_SECRET.to_string()), + )], + false, + ) + .unwrap(); + + let mocks = set_expectations_for_storing_access_token(&f.config); + + assert_eq!( + f.bitbucket + .request_token(ORIGIN, CONSUMER_KEY, CONSUMER_SECRET) + .unwrap(), + TOKEN + ); + + assert_stored_access_token(&mocks, f.time, false); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_request_access_token_with_username_and_password() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + // A 400 status makes the mocked HttpDownloader raise a TransportException(400), + // matching PHP's willThrowException for the BAD REQUEST case. + let mut f = set_up_with_config_and_http( + config, + vec![expect_full( + Bitbucket::OAUTH2_ACCESS_TOKEN_URL, + Some(access_token_request_options()), + 400, + "", + vec![], + )], + ); + + f.io + .borrow_mut() + .expects( + vec![ + Expectation::auth(ORIGIN, USERNAME, Some(PASSWORD.to_string())), + Expectation::text("Invalid OAuth consumer provided."), + Expectation::text("This can have three reasons:"), + Expectation::text( + "1. You are authenticating with a bitbucket username/password combination", + ), + Expectation::text( + "2. You are using an OAuth consumer, but didn't configure a (dummy) callback url", + ), + Expectation::text( + "3. You are using an OAuth consumer, but didn't configure it as private consumer", + ), + ], + true, + ) + .unwrap(); + + assert_eq!( + f.bitbucket + .request_token(ORIGIN, USERNAME, PASSWORD) + .unwrap(), + "" + ); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_request_access_token_with_username_and_password_with_unauthorized_response() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let mut f = set_up_with_config_and_http( + config, + vec![expect_full( + Bitbucket::OAUTH2_ACCESS_TOKEN_URL, + Some(access_token_request_options()), + 401, + "", + vec![], + )], + ); + + f.io + .borrow_mut() + .expects( + vec![ + Expectation::auth(ORIGIN, USERNAME, Some(PASSWORD.to_string())), + Expectation::text("Invalid OAuth consumer provided."), + Expectation::text( + "You can also add it manually later by using \"composer config --global --auth bitbucket-oauth.bitbucket.org <consumer-key> <consumer-secret>\"", + ), + ], + true, + ) + .unwrap(); + + assert_eq!( + f.bitbucket + .request_token(ORIGIN, USERNAME, PASSWORD) + .unwrap(), + "" + ); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_request_access_token_with_username_and_password_with_not_found_response() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let mut f = set_up_with_config_and_http( + config, + vec![expect_full( + Bitbucket::OAUTH2_ACCESS_TOKEN_URL, + Some(access_token_request_options()), + 404, + "", + vec![], + )], + ); + + f.io.borrow_mut() + .expects( + vec![Expectation::auth( + ORIGIN, + USERNAME, + Some(PASSWORD.to_string()), + )], + false, + ) + .unwrap(); + + let result = f.bitbucket.request_token(ORIGIN, USERNAME, PASSWORD); + assert!( + result.is_err(), + "expected a TransportException to propagate" + ); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_username_password_authentication_flow() { - todo!() + let url = format!("https://{}/site/oauth2/access_token", ORIGIN); + let body = format!( + "{{\"access_token\": \"{}\", \"scopes\": \"repository\", \"expires_in\": 3600, \"refresh_token\": \"refresh_token\", \"token_type\": \"bearer\"}}", + TOKEN + ); + // PHP matches the URL with `$this->anything()` for options, so match any options. + let config = ConfigStubBuilder::new().build_shared(); + let mut f = + set_up_with_config_and_http(config, vec![expect_full(url, None, 200, body, vec![])]); + + f.io.borrow_mut() + .expects( + vec![ + Expectation::text(MESSAGE), + Expectation::ask("Consumer Key (hidden): ", CONSUMER_KEY), + Expectation::ask("Consumer Secret (hidden): ", CONSUMER_SECRET), + ], + false, + ) + .unwrap(); + + let mocks = set_expectations_for_storing_access_token(&f.config); + + assert!( + f.bitbucket + .authorize_oauth_interactively(ORIGIN, Some(MESSAGE)) + .unwrap() + ); + + assert_stored_access_token(&mocks, f.time, true); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mock for Config (no mock infrastructure)"] fn test_authorize_oauth_interactively_with_empty_username() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let mut f = set_up_with_config_and_http(config, vec![]); + + // getAuthConfigSource() is consulted while printing the instructions. + let auth_calls = Rc::new(RefCell::new(ConfigSourceCalls::default())); + f.config + .borrow_mut() + .set_auth_config_source(Box::new(ConfigSourceMock { + name: "auth-config-source".to_string(), + calls: auth_calls, + })); + + f.io.borrow_mut() + .expects(vec![Expectation::ask("Consumer Key (hidden): ", "")], false) + .unwrap(); + + assert!( + !f.bitbucket + .authorize_oauth_interactively(ORIGIN, Some(MESSAGE)) + .unwrap() + ); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mock for Config (no mock infrastructure)"] fn test_authorize_oauth_interactively_with_empty_password() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let mut f = set_up_with_config_and_http(config, vec![]); + + let auth_calls = Rc::new(RefCell::new(ConfigSourceCalls::default())); + f.config + .borrow_mut() + .set_auth_config_source(Box::new(ConfigSourceMock { + name: "auth-config-source".to_string(), + calls: auth_calls, + })); + + f.io.borrow_mut() + .expects( + vec![ + Expectation::text(MESSAGE), + Expectation::ask("Consumer Key (hidden): ", CONSUMER_KEY), + Expectation::ask("Consumer Secret (hidden): ", ""), + ], + false, + ) + .unwrap(); + + assert!( + !f.bitbucket + .authorize_oauth_interactively(ORIGIN, Some(MESSAGE)) + .unwrap() + ); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_authorize_oauth_interactively_with_request_access_token_failure() { - todo!() -} + let url = format!("https://{}/site/oauth2/access_token", ORIGIN); + let config = ConfigStubBuilder::new().build_shared(); + // A 400 status makes the mocked HttpDownloader raise a TransportException(400). + let mut f = set_up_with_config_and_http(config, vec![expect_full(url, None, 400, "", vec![])]); -#[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config to construct Bitbucket (no mock infrastructure)"] -fn test_get_token_without_access_token() { - todo!() + let auth_calls = Rc::new(RefCell::new(ConfigSourceCalls::default())); + f.config + .borrow_mut() + .set_auth_config_source(Box::new(ConfigSourceMock { + name: "auth-config-source".to_string(), + calls: auth_calls, + })); + + f.io.borrow_mut() + .expects( + vec![ + Expectation::text(MESSAGE), + Expectation::ask("Consumer Key (hidden): ", CONSUMER_KEY), + Expectation::ask("Consumer Secret (hidden): ", CONSUMER_SECRET), + ], + false, + ) + .unwrap(); + + assert!( + !f.bitbucket + .authorize_oauth_interactively(ORIGIN, Some(MESSAGE)) + .unwrap() + ); } #[test] -#[ignore = "needs getMockBuilder mock for Config and @depends-injected Bitbucket from a mock-based test (no mock infrastructure)"] -fn test_get_token_with_access_token() { - todo!() +fn test_get_token_without_access_token() { + let config = ConfigStubBuilder::new().build_shared(); + let f = set_up_with_config_and_http(config, vec![]); + assert_eq!(f.bitbucket.get_token(), ""); } #[test] -#[ignore = "needs getIOMock/IOMock and getMockBuilder mocks for HttpDownloader/Config to construct Bitbucket (no mock infrastructure)"] fn test_authorize_oauth_with_wrong_origin_url() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let mut f = set_up_with_config_and_http(config, vec![]); + assert!(!f.bitbucket.authorize_oauth(&format!("non-{}", ORIGIN))); } #[test] -#[ignore = "needs getIOMock/IOMock, getProcessExecutorMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_authorize_oauth_without_available_git_config_token() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let (io_mock, _io_guard) = get_io_mock(io_interface::DEBUG).unwrap(); + let (http_downloader, _http_guard) = + get_http_downloader_mock(vec![], true, HttpDownloaderMockHandler::default()); + let (process, _process_guard) = get_process_executor_mock( + vec![], + false, + MockHandler { + r#return: -1, + ..Default::default() + }, + ); + + let io: Rc<RefCell<dyn IOInterface>> = io_mock.clone(); + let time = time(); + let mut bitbucket = + Bitbucket::new(io, config, Some(process), Some(http_downloader), Some(time)).unwrap(); + + assert!(!bitbucket.authorize_oauth(ORIGIN)); } #[test] -#[ignore = "needs getIOMock/IOMock, getProcessExecutorMock and getMockBuilder mocks for HttpDownloader/Config (no mock infrastructure)"] fn test_authorize_oauth_with_available_git_config_token() { - todo!() + let config = ConfigStubBuilder::new().build_shared(); + let (io_mock, _io_guard) = get_io_mock(io_interface::DEBUG).unwrap(); + let (http_downloader, _http_guard) = + get_http_downloader_mock(vec![], true, HttpDownloaderMockHandler::default()); + let (process, _process_guard) = + get_process_executor_mock(vec![], false, MockHandler::default()); + + let io: Rc<RefCell<dyn IOInterface>> = io_mock.clone(); + let time = time(); + let mut bitbucket = + Bitbucket::new(io, config, Some(process), Some(http_downloader), Some(time)).unwrap(); + + assert!(bitbucket.authorize_oauth(ORIGIN)); } |