Initial commit

.gitattributes

@@ -0,0 +1,13 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.editorconfig               export-ignore
+/.gitattributes              export-ignore
+/.gitignore                  export-ignore
+/.github/PULL_REQUEST_TEMPLATE.md    export-ignore
+/.github/ISSUE_TEMPLATE.md           export-ignore
+/phpcs.xml.dist              export-ignore
+/phpunit.xml.dist            export-ignore
+/tests                       export-ignore
+/docs                        export-ignore

.gitignore

@@ -0,0 +1,9 @@
+build
+composer.lock
+vendor
+phpcs.xml
+phpunit.xml
+.phpunit.result.cache
+node_modules
+npm-debug.log
+*.log

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to `basement-common` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## NEXT - YYYY-MM-DD
+
+### Added
+
+#### v0.1.0
+ - Updated requirements to >= Laravel 10
+ - Rearranged .github
+
+
+
+#### v0.0.8
+
+- Initial interfaces for domain and server services.
+- Initial abstract classes for domains, regions, servers, sizes, and sshkeys.
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Removed
+- Nothing
+
+### Security
+- Nothing

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `[email protected]`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/austinkregel/basement-common).
+
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your main branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2024 Austin Kregel <[email protected]>
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

README.md

@@ -0,0 +1,82 @@
+# basement-common
+
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Total Downloads][ico-downloads]][link-downloads]
+
+This package is a basic QEMU management interface using the interfaces from [the-basement/common](https://packagist.org/packages/the-basement/common). 
+
+## Install
+
+Via Composer
+
+``` bash
+$ composer require the-basement/libvirt
+```
+
+## Basic Usage
+
+Creating a VM in QEMU/KVM
+
+```php
+// This assumes you have an ubuntu server image available from your KVM host
+// This also assumes the default image location of the disks created by KVM.
+// Both of these can be changed; disks that exist will not be overwritten
+// disks that don't exist will be created.
+$service = new TheBasement\Libvirt\LibvirtService();
+$service->createServer([
+    'name' => 'my-virtual-machine',
+    'memory' => (string) (1024 * 1024), // 1G in KiB
+    'cores' => 1,
+    'threads' => 1,
+    'iso_path' => '/var/lib/libvirt/iso/ubuntu-22.04.4-live-server-amd64.iso',
+    'storage_pool' => 'default',
+    'network_mac' => '',
+    'video_ram' => '65536', // bytes of video ram
+    'disk_path' => '/var/lib/libvirt/images/ubuntu22.04-2.qcow2',
+    'disk_name' => 'ubuntu22.04-2.qcow2',
+    'disk_capacity' => 10 * 1024 * 1024 * 1024, // 10 GB in bytes
+]);
+
+// Gets all servers defined for the KVM
+$servers = $service->findAllServers();
+```
+
+
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
+
+## Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+## Credits
+
+- [Austin Kregel][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+[ico-version]: https://img.shields.io/packagist/v/the-basement/libvirt.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/the-basement/libvirt.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/the-basement/libvirt.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/the-basement/libvirt
+[link-downloads]: https://packagist.org/packages/the-basement/libvirt
+[link-author]: https://github.com/austinkregel
+[link-contributors]: ../../contributors

composer.json

@@ -0,0 +1,44 @@
+{
+    "name": "the-basement/libvirt",
+    "type": "library",
+    "description": "This package implements the domain service contract for the libvirt hypervisor.",
+    "keywords": [
+        "thebasement.club",
+        "libvirt",
+        "hypervisor",
+        "kvm",
+        "qemu",
+        "virtualization"
+    ],
+    "homepage": "https://github.com/The-Basement-Club/basement-libvirt",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Austin Kregel",
+            "email": "[email protected]",
+            "homepage": "https://austinkregel.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=8.2",
+        "the-basement/common": "^0.1.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "TheBasement\\Libvirt\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "TheBasement\\Libvirt\\Tests\\": "tests"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "require-dev": {
+        "laravel/pint": "^1.15",
+        "phpunit/phpunit": "^11.1"
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage>
+    <report>
+      <clover outputFile="build/logs/clover.xml"/>
+      <html outputDirectory="build/coverage"/>
+      <text outputFile="build/coverage.txt"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="Basement Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <logging>
+    <junit outputFile="build/report.junit.xml"/>
+  </logging>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </source>
+</phpunit>

src/LibvirtBasementServiceProvider.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+namespace TheBasement\Libvirt;
+
+use Illuminate\Support\ServiceProvider;
+use TheBasement\Common\Services\ServerServiceFactory;
+
+class LibvirtBasementServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        // The User should be setting up the factory in their app service provider, so we'll just register the service.
+        $this->app->make(ServerServiceFactory::class)
+            ->register('libvirt', LibvirtService::class);
+    }
+
+    public function boot()
+    {
+        //
+    }
+}