Compare commits

..

1 Commits
1.x ... 0.x

Author SHA1 Message Date
R. Eric Wheeler 1970f317a4 Add new file 2021-01-21 19:43:12 +00:00
7 changed files with 53 additions and 131 deletions

View File

@ -1,38 +0,0 @@
name: PHP Composer
on:
push:
branches: [ master, 1.x ]
pull_request:
branches: [ master, 1.x ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Validate composer.json and composer.lock
run: composer validate
- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v2
with:
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-
- name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true'
run: composer install --prefer-dist --no-progress --no-suggest
# Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
# Docs: https://getcomposer.org/doc/articles/scripts.md
- name: Tests
run: vendor/bin/phpunit
# - name: Run test suite
# run: composer run-script test

View File

@ -1,48 +0,0 @@
name: Tests
on:
push:
branches: [ 0.x ]
pull_request:
branches: [ 0.x ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
php: ['7.3', '7.4', '8.0']
steps:
- uses: actions/checkout@v2
- name: Validate composer.json and composer.lock
run: composer validate
- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v2
with:
path: vendor
key: ${{ matrix-php }}-composer-${{ hashFiles('**/composer.lock') }}
restore-keys: ${{ matrix.php }}-composer-
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
coverage: "none"
extensions: "json,sodium"
php-version: "${{ matrix.php }}"
- name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true'
run: composer install --prefer-dist --no-progress --no-suggest
# Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
# Docs: https://getcomposer.org/doc/articles/scripts.md
- name: Run tests
run: vendor/bin/phpunit -v
# - name: Run test suite
# run: composer run-script test

View File

@ -12,7 +12,9 @@ return PhpCsFixer\Config::create()
[ [
'@PSR2' => true, '@PSR2' => true,
'@PHP70Migration' => true, '@PHP70Migration' => true,
'@PHP70Migration:risky' => true,
'@PHP71Migration' => true, '@PHP71Migration' => true,
'@PHP71Migration:risky' => true,
'header_comment' => ['header' => $header], 'header_comment' => ['header' => $header],
'ordered_class_elements' => true, 'ordered_class_elements' => true,
'ordered_imports' => true, 'ordered_imports' => true,

View File

@ -2,13 +2,7 @@
### Small library to generate unique private mac addresses ### Small library to generate unique private mac addresses
[![pipeline status](https://repos.bgemi.net/sikofitt/generate-mac/badges/1.x/pipeline.svg)](https://repos.bgemi.net/sikofitt/generate-mac/-/commits/1.x)
[![coverage report](https://repos.bgemi.net/sikofitt/generate-mac/badges/1.x/coverage.svg)](https://repos.bgemi.net/sikofitt/generate-mac/-/commits/1.x)
#### Install #### Install
Requires PHP v8.0, For versions compatible with PHP >= 7.3 use the 0.x branch.
[composer](https://getcomposer.org) [composer](https://getcomposer.org)
```bash ```bash
composer require sikofitt/generate-mac composer require sikofitt/generate-mac
@ -98,4 +92,4 @@ user@localhost:~/generate-mac$ vendor/bin/phpunit
#### License #### License
[GPL-3.0](LICENSE) [GPL-3.0](LICENSE)

View File

@ -3,7 +3,7 @@
"description": "Generates dummy mac addresses", "description": "Generates dummy mac addresses",
"type": "library", "type": "library",
"require": { "require": {
"php": "^8.2", "php": ">=7.3",
"ext-json": "*", "ext-json": "*",
"ext-sodium": "*" "ext-sodium": "*"
}, },
@ -13,11 +13,10 @@
} }
}, },
"require-dev": { "require-dev": {
"composer/xdebug-handler": "^3.0", "friendsofphp/php-cs-fixer": "^2.18",
"friendsofphp/php-cs-fixer": "^3.17", "phpunit/phpunit": "^9.5",
"phpunit/phpunit": "^9.6", "squizlabs/php_codesniffer": "^3.5",
"squizlabs/php_codesniffer": "^3.7", "symfony/console": "^4.4|^5.0"
"symfony/console": "^6.3"
}, },
"autoload-dev": { "autoload-dev": {
"psr-4": { "psr-4": {

View File

@ -34,20 +34,16 @@ use Symfony\Component\Console\Style\SymfonyStyle;
class GenerateMacCommand extends Command class GenerateMacCommand extends Command
{ {
private const SEPARATOR_NAMES = [
'colon',
'dash',
'none',
];
public function configure(): void public function configure(): void
{ {
$this $this
->setName('generate-mac') ->setName('generate-mac')
->addOption('count', 'c', InputOption::VALUE_REQUIRED, 'Generate {count} mac addresses.') ->addOption('count', 'c', InputOption::VALUE_REQUIRED, 'Generate {count} mac addresses.')
->addOption('output', 'o', InputOption::VALUE_REQUIRED, 'Output in this format instead of a string. [json, plain, string]') ->addOption('output', 'o', InputOption::VALUE_REQUIRED, 'Output in this format instead of a string. [json,plain,string]')
->addOption('separator', 's', InputOption::VALUE_REQUIRED, 'The separator to use for mac addresses. [colon, dash, none]') ->addOption('separator', 's', InputOption::VALUE_REQUIRED, 'The separator to use for mac addresses.')
; ;
parent::configure();
} }
/** /**
@ -65,9 +61,9 @@ class GenerateMacCommand extends Command
throw new RuntimeException('$count should be a positive number greater than zero.'); throw new RuntimeException('$count should be a positive number greater than zero.');
} }
$separatorName = strtolower($input->getOption('separator') ?? 'colon'); $separator = strtolower($input->getOption('separator') ?? 'colon');
if (!\in_array($separatorName, self::SEPARATOR_NAMES, true)) { if (!\in_array($separator, ['colon','none','dash'], true)) {
throw new InvalidArgumentException('Separator must be one of "colon", "none", or "dash"'); throw new InvalidArgumentException('Separator must be one of "colon", "none", or "dash"');
} }
@ -75,21 +71,23 @@ class GenerateMacCommand extends Command
$io = new SymfonyStyle($input, $output); $io = new SymfonyStyle($input, $output);
$separator = match($separatorName) { switch ($separator) {
'colon' => Mac::SEPARATOR_COLON, case 'colon':
'dash' => Mac::SEPARATOR_DASH, default:
'none' => Mac::SEPARATOR_NONE, $separator = Mac::SEPARATOR_COLON;
default => Mac::SEPARATOR_COLON, break;
}; case 'none':
$separator = Mac::SEPARATOR_NONE;
break;
case 'dash':
$separator = Mac::SEPARATOR_DASH;
break;
}
$mac = new Mac($separator); $mac = new Mac($separator);
$macAddresses = $mac->getMacAddresses($count); $macAddresses = $mac->getMacAddresses($count);
if(empty($macAddresses)) {
return Command::FAILURE;
}
switch ($outputFormat) { switch ($outputFormat) {
case 'string': case 'string':
default: default:
@ -104,6 +102,6 @@ class GenerateMacCommand extends Command
break; break;
} }
return Command::SUCCESS; return 0;
} }
} }

View File

@ -24,7 +24,6 @@ class Mac
public const SEPARATOR_COLON = 0; public const SEPARATOR_COLON = 0;
public const SEPARATOR_DASH = 1; public const SEPARATOR_DASH = 1;
public const SEPARATOR_NONE = 2; public const SEPARATOR_NONE = 2;
/** /**
* Private mac address prefixes that are used * Private mac address prefixes that are used
* internally or with virtual machines and containers. * internally or with virtual machines and containers.
@ -69,10 +68,22 @@ class Mac
protected $isTest = false; protected $isTest = false;
/** /**
* @var int The mac address separator, can be self::SEPARATOR_*
*/
private $separator;
/**
* @var bool If we care if we get an already used prefix or not.
*/
private $unique;
/**
* Mac constructor.
*
* @param int $separator The mac address separator, one of self::SEPARATOR_* * @param int $separator The mac address separator, one of self::SEPARATOR_*
* @param bool $unique Whether or not we care if we get a non unique prefix. * @param bool $unique Whether or not we care if we get a non unique prefix.
*/ */
public function __construct(private int $separator = self::SEPARATOR_COLON, private bool $unique = true) public function __construct(int $separator = self::SEPARATOR_COLON, bool $unique = true)
{ {
$this->setUnique($unique); $this->setUnique($unique);
$this->setSeparator($separator); $this->setSeparator($separator);
@ -185,12 +196,16 @@ class Mac
*/ */
public function getSeparatorAsString(): string public function getSeparatorAsString(): string
{ {
return match ( $this->getSeparator() ) {
self::SEPARATOR_COLON => ':', switch ($this->getSeparator()) {
self::SEPARATOR_DASH => '-', default:
self::SEPARATOR_NONE => '', case self::SEPARATOR_COLON:
default => ':', return ':';
}; case self::SEPARATOR_DASH:
return '-';
case self::SEPARATOR_NONE:
return '';
}
} }
/** /**
@ -215,11 +230,11 @@ class Mac
*/ */
private function generateString(string $template): string private function generateString(string $template): string
{ {
$bytes = \sodium_bin2hex(\random_bytes(32)); $bytes = sodium_bin2hex(\random_bytes(32));
while (false !== $pos = \strpos($template, 'x')) { while (false !== $pos = \strpos($template, 'x')) {
$replacement = $bytes[\random_int(0, \strlen($bytes) -1)]; $replacement = $bytes[\random_int(0, \strlen($bytes) -1)];
$template = \substr_replace($template, $replacement, $pos, 1); $template = substr_replace($template, $replacement, $pos, 1);
} }
return $template; return $template;
@ -244,6 +259,6 @@ class Mac
*/ */
private function insertSeparator(string $macAddress): string private function insertSeparator(string $macAddress): string
{ {
return \implode($this->getSeparatorAsString(), \str_split($macAddress, 2)); return implode($this->getSeparatorAsString(), str_split($macAddress, 2));
} }
} }