/simple-test-data

Provide sets of test data

Primary LanguagePowerShellGNU General Public License v3.0GPL-3.0

simple-test-data

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Simple Test Data

A PowerShell module that provides commands that create test data.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

PowerShell because it can be easily accessed from Linux and Windows machines and all of the source it uses is available for inspection.

This means the scripts can be used from editors like VSCode but also GitHub Actions can run them.

This means that security can assure themselves that the code is not harmful.

Product Name Screen Shot

(back to top)

https://github.com/Simple-Innovation/simple-test-data/blob/main/LICENSE.txt

Built With

  • PowerShell

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

If using a system without PowerShell installed, e.g. GitHub CodeSpaces.

  • PowerShell (Ubuntu)

    wget -q https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
    sudo dpkg -i packages-microsoft-prod.deb
    sudo apt update
    sudo apt install powershell
    pwsh

Installation

  1. Clone the repo

    git clone https://github.com/Simple-Innovation/simple-test-data.git
  2. Install PowerShell Module

    Import-Module ./SimpleTestData.psm1 

(back to top)

Usage

  1. Create 10 KiB of test data in the test folder based on the files and folders in the seed folder.
Copy-DataCollection -SourceFolder:./seed/ -TargetFolder:./test/ -MaximumByteTotal:$(10 * 1024)

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Detect empty folders
  • Limit based on existing folder size

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sebastian Rogers - @SebastianRoger8 - sebastian.rogers@simpleinnovation.co.uk

Project Link: https://github.com/Simple-Innovation/simple-test-data

(back to top)

Acknowledgments

(back to top)