Skip to content

Fix package name is retrieved from wrong branch. #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 4 commits into from
Jan 13, 2018
Merged

Fix package name is retrieved from wrong branch. #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d71fc0c
Get package composer.json by version/branch.
gitlost Jan 8, 2018
0f58478
Remove incorrect comment.
gitlost Jan 8, 2018
d75a4ae
Use wp-cli-test/version-composer-json-different not gitlost.
gitlost Jan 8, 2018
ac39997
Merge branch 'master' into issue-51-wrong-branch
schlessera Jan 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 56 additions & 2 deletions features/package-install.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,10 +360,18 @@ Feature: Install WP-CLI packages
Scenario: Install a package from Git using a shortened package identifier with a specific version
Given an empty directory

When I run `wp package install schlessera/test-command:0.1.0`
# Need to specify actual tag.
When I try `wp package install schlessera/test-command:0.1.0`
Then STDERR should contain:
"""
Error: Couldn't download composer.json file from 'https://github.com/schlessera/test-command/0.1.0/composer.json' (HTTP code 404).
"""
And STDOUT should be empty

When I run `wp package install schlessera/test-command:v0.1.0`
Then STDOUT should contain:
"""
Installing package schlessera/test-command (0.1.0)
Installing package schlessera/test-command (v0.1.0)
Updating {PACKAGE_PATH}composer.json to require the package...
Registering https://github.com/schlessera/test-command.git as a VCS repository...
Using Composer to install the package...
Expand Down Expand Up @@ -588,6 +596,52 @@ Feature: Install WP-CLI packages
rocket
"""

@github-api
Scenario: Install a package with a composer.json that differs between versions
Given an empty directory

When I run `wp package install wp-cli-test/version-composer-json-different:v1.0.0`
Then STDOUT should contain:
"""
Installing package wp-cli-test/version-composer-json-different (v1.0.0)
Updating {PACKAGE_PATH}composer.json to require the package...
"""
And STDOUT should contain:
"""
Success: Package installed.
"""
And the {PACKAGE_PATH}/vendor/wp-cli-test/version-composer-json-different/composer.json file should exist
And the {PACKAGE_PATH}/vendor/wp-cli-test/version-composer-json-different/composer.json file should contain:
"""
1.0.0
"""
And the {PACKAGE_PATH}/vendor/wp-cli-test/version-composer-json-different/composer.json file should not contain:
"""
1.0.1
"""
And the {PACKAGE_PATH}/vendor/wp-cli/profile-command directory should not exist

When I run `wp package install wp-cli-test/version-composer-json-different:v1.0.1`
Then STDOUT should contain:
"""
Installing package wp-cli-test/version-composer-json-different (v1.0.1)
Updating {PACKAGE_PATH}composer.json to require the package...
"""
And STDOUT should contain:
"""
Success: Package installed.
"""
And the {PACKAGE_PATH}/vendor/wp-cli-test/version-composer-json-different/composer.json file should exist
And the {PACKAGE_PATH}/vendor/wp-cli-test/version-composer-json-different/composer.json file should contain:
"""
1.0.1
"""
And the {PACKAGE_PATH}/vendor/wp-cli-test/version-composer-json-different/composer.json file should not contain:
"""
1.0.0
"""
And the {PACKAGE_PATH}/vendor/wp-cli/profile-command directory should exist

Scenario: Install a package from a local zip
Given an empty directory
And I run `wget -q -O google-sitemap-generator-cli.zip https://github.com/wp-cli/google-sitemap-generator-cli/archive/master.zip`
Expand Down
36 changes: 33 additions & 3 deletions src/Package_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ public function install( $args, $assoc_args ) {
if ( is_string( $package ) ) {
if ( $this->is_git_repository( $package ) ) {
$git_package = $package;
$package_name = $this->check_git_package_name( $package_name );
$package_name = $this->check_git_package_name( $package_name, $version );
}
} elseif ( $package_name !== $package->getPrettyName() ) {
// BC support for specifying lowercase names for mixed-case package index packages - don't bother warning.
Expand Down Expand Up @@ -972,10 +972,14 @@ private function is_git_repository( $package ) {

/**
* Checks that `$package_name` matches the name in the repo composer.json, and return corrected value if not.
*
* @string $package_name Package name to check.
* @string $version Optional. Package version. Default 'master'.
* @string Package name, possibly changed to match that in repo.
*/
private function check_git_package_name( $package_name ) {
private function check_git_package_name( $package_name, $version = '' ) {
// Generate raw git URL of composer.json file.
$raw_content_url = 'https://github.com/' . $package_name . '/master/composer.json';
$raw_content_url = 'https://github.com/' . $package_name . '/' . $this->get_raw_git_version( $version ) . '/composer.json';
$github_token = getenv( 'GITHUB_TOKEN' ); // Use GITHUB_TOKEN if available to avoid authorization failures or rate-limiting.
$headers = $github_token ? array( 'Authorization' => 'token ' . $github_token ) : array();

Expand Down Expand Up @@ -1004,6 +1008,32 @@ private function check_git_package_name( $package_name ) {
return $package_name;
}

/**
* Get the version to use for raw github request. Very basic.
*
* @string $version Package version.
* @string Version to use for github request.
*/
private function get_raw_git_version( $version ) {
if ( '' !== $version ) {
// If Composer hash given then just use whatever's after it.
if ( false !== ( $hash_pos = strpos( $version, '#' ) ) ) {
$version = substr( $version, $hash_pos + 1 );
} else {
// Strip any Composer 'dev-' prefix.
if ( 0 === strncmp( $version, 'dev-', 4 ) ) {
$version = substr( $version, 4 );
}
// Ignore/strip any relative suffixes.
if ( false !== ( $rel_pos = strpos( $version, '^' ) ) || false !== ( $rel_pos = strpos( $version, '~' ) ) ) {
$version = substr( $version, 0, $rel_pos );
}
}
}
// Default to master.
return '' === $version ? 'master' : $version;
}

/**
* Sets `COMPOSER_AUTH` environment variable (which Composer merges into the config setup in `Composer\Factory::createConfig()`) depending on available environment variables.
* Avoids authorization failures when accessing various sites.
Expand Down