mirror of
https://github.com/actions/setup-python.git
synced 2025-12-23 16:57:07 +00:00
Add support for custom PyPI repository configuration
- Add pypi-url, pypi-username, and pypi-password inputs to action.yml - Implement configurePipRepository() function in utils.ts to create pip.conf/pip.ini - Integrate pip configuration into setup-python.ts workflow - Add comprehensive unit tests for pip configuration functionality - Update README.md with usage examples and documentation - Automatically mask credentials in logs for security Fixes #814
This commit is contained in:
parent
83679a892e
commit
f054be5a92
5 changed files with 222 additions and 2 deletions
|
|
@ -17,7 +17,8 @@ import {
|
|||
isGhes,
|
||||
IS_WINDOWS,
|
||||
getDownloadFileName,
|
||||
getVersionInputFromToolVersions
|
||||
getVersionInputFromToolVersions,
|
||||
configurePipRepository
|
||||
} from '../src/utils';
|
||||
|
||||
jest.mock('@actions/cache');
|
||||
|
|
@ -378,3 +379,106 @@ describe('isGhes', () => {
|
|||
expect(isGhes()).toBeTruthy();
|
||||
});
|
||||
});
|
||||
|
||||
describe('configurePipRepository', () => {
|
||||
const originalHome = process.env.HOME;
|
||||
const originalUserProfile = process.env.USERPROFILE;
|
||||
const testHome = path.join(tempDir, 'home');
|
||||
|
||||
beforeEach(() => {
|
||||
// Setup test home directory
|
||||
process.env.HOME = testHome;
|
||||
process.env.USERPROFILE = testHome;
|
||||
if (fs.existsSync(testHome)) {
|
||||
fs.rmSync(testHome, {recursive: true, force: true});
|
||||
}
|
||||
fs.mkdirSync(testHome, {recursive: true});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
// Cleanup
|
||||
if (fs.existsSync(testHome)) {
|
||||
fs.rmSync(testHome, {recursive: true, force: true});
|
||||
}
|
||||
process.env.HOME = originalHome;
|
||||
process.env.USERPROFILE = originalUserProfile;
|
||||
});
|
||||
|
||||
it('creates pip config file with URL only', async () => {
|
||||
const pypiUrl = 'https://nexus.example.com/repository/pypi/simple';
|
||||
await configurePipRepository(pypiUrl);
|
||||
|
||||
const configDir = IS_WINDOWS
|
||||
? path.join(testHome, 'pip')
|
||||
: path.join(testHome, '.pip');
|
||||
const configFile = IS_WINDOWS ? 'pip.ini' : 'pip.conf';
|
||||
const configPath = path.join(configDir, configFile);
|
||||
|
||||
expect(fs.existsSync(configPath)).toBeTruthy();
|
||||
const content = fs.readFileSync(configPath, 'utf8');
|
||||
expect(content).toContain('[global]');
|
||||
expect(content).toContain(`index-url = ${pypiUrl}`);
|
||||
});
|
||||
|
||||
it('creates pip config file with credentials', async () => {
|
||||
const pypiUrl = 'https://nexus.example.com/repository/pypi/simple';
|
||||
const username = 'testuser';
|
||||
const password = 'testpass';
|
||||
await configurePipRepository(pypiUrl, username, password);
|
||||
|
||||
const configDir = IS_WINDOWS
|
||||
? path.join(testHome, 'pip')
|
||||
: path.join(testHome, '.pip');
|
||||
const configFile = IS_WINDOWS ? 'pip.ini' : 'pip.conf';
|
||||
const configPath = path.join(configDir, configFile);
|
||||
|
||||
expect(fs.existsSync(configPath)).toBeTruthy();
|
||||
const content = fs.readFileSync(configPath, 'utf8');
|
||||
expect(content).toContain('[global]');
|
||||
expect(content).toContain('index-url = https://testuser:testpass@');
|
||||
expect(content).toContain('nexus.example.com/repository/pypi/simple');
|
||||
});
|
||||
|
||||
it('does nothing when pypiUrl is not provided', async () => {
|
||||
await configurePipRepository('');
|
||||
|
||||
const configDir = IS_WINDOWS
|
||||
? path.join(testHome, 'pip')
|
||||
: path.join(testHome, '.pip');
|
||||
|
||||
expect(fs.existsSync(configDir)).toBeFalsy();
|
||||
});
|
||||
|
||||
it('warns when only username is provided', async () => {
|
||||
const warningMock = jest.spyOn(core, 'warning');
|
||||
const pypiUrl = 'https://nexus.example.com/repository/pypi/simple';
|
||||
const username = 'testuser';
|
||||
await configurePipRepository(pypiUrl, username);
|
||||
|
||||
expect(warningMock).toHaveBeenCalledWith(
|
||||
'Both pypi-username and pypi-password must be provided for authentication. Configuring without credentials.'
|
||||
);
|
||||
});
|
||||
|
||||
it('warns when only password is provided', async () => {
|
||||
const warningMock = jest.spyOn(core, 'warning');
|
||||
const pypiUrl = 'https://nexus.example.com/repository/pypi/simple';
|
||||
const password = 'testpass';
|
||||
await configurePipRepository(pypiUrl, undefined, password);
|
||||
|
||||
expect(warningMock).toHaveBeenCalledWith(
|
||||
'Both pypi-username and pypi-password must be provided for authentication. Configuring without credentials.'
|
||||
);
|
||||
});
|
||||
|
||||
it('creates config directory if it does not exist', async () => {
|
||||
const pypiUrl = 'https://nexus.example.com/repository/pypi/simple';
|
||||
const configDir = IS_WINDOWS
|
||||
? path.join(testHome, 'pip')
|
||||
: path.join(testHome, '.pip');
|
||||
|
||||
expect(fs.existsSync(configDir)).toBeFalsy();
|
||||
await configurePipRepository(pypiUrl);
|
||||
expect(fs.existsSync(configDir)).toBeTruthy();
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue