chore: Initial commit

Author: erezrokah

.dockerignore

@@ -0,0 +1,87 @@
+# Git
+.git
+.gitignore
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Test outputs
+sqlite_test_output/
+ultra_performance_results/
+performance_comparison/
+test_data/
+*.db
+*.db-journal
+*.db-wal
+*.db-shm
+*.log
+*.csv
+*.json
+
+# Documentation
+*.md
+!README.md
+
+# Docker
+Dockerfile
+docker-compose.yml
+.dockerignore
+
+# Development tools
+.pre-commit-config.yaml
+pyproject.toml
+setup.py
+Makefile
+
+# Coverage and testing
+.coverage
+.pytest_cache/
+htmlcov/
+.tox/
+.nox/ 

.github/.kodiak.toml

@@ -0,0 +1,15 @@
+version = 1
+
+[approve]
+auto_approve_usernames = ["cq-bot"]
+
+[merge.message]
+body = "pull_request_body"
+cut_body_after = "Use the following steps to ensure your PR is ready to be reviewed"
+cut_body_and_text = true
+cut_body_before = "<!-- 🎉 Thank you for making CloudQuery awesome by submitting a PR 🎉 -->"
+title = "pull_request_title"
+
+[merge]
+blocking_labels = ["wip", "no automerge"]
+notify_on_conflict = false

.github/renovate.json5

@@ -0,0 +1,3 @@
+{
+  extends: ["github>cloudquery/.github//.github/renovate-python-default.json5"],
+}

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+          cache-dependency-path: "requirements.txt"
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: fmt
+        run: make fmt-check

.gitignore

@@ -0,0 +1,7 @@
+.cq/
+benchmark_results/
+cloudquery.log
+
+*.pem
+
+.DS_Store

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing to CloudQuery Benchmark
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+We're happy to accept contributions to the CloudQuery Benchmark.
+
+## How Can I Contribute?
+
+1. First visit our [README](./README.md) to get started.
+2. Then read our [Code of Conduct](./CODE_OF_CONDUCT.md) guidelines.
+3. Then follow the [GitHub documentation about forking a repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
+4. Before [submitting a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request), ensure your code is formatted using `make fmt`.
+
+If you have any questions, please open an issue in our [GitHub repository](https://github.com/cloudquery/benchmark/issues).

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CloudQuery Performance Testing Project
+
+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.

Makefile

@@ -0,0 +1,5 @@
+fmt:
+	black .
+
+fmt-check:
+	black --check .

README.md

@@ -0,0 +1,76 @@
+# CloudQuery Benchmark
+
+This is a benchmark for CloudQuery. It is used to measure the performance of CloudQuery.
+
+## Prerequisites
+
+- Python version equal or higher than 3.11
+- CloudQuery CLI installed (see [CloudQuery CLI](https://docs.cloudquery.io/docs))
+
+## Setup
+
+The benchmark will use only the configured sources, and optionally the S3 destination.
+
+### AWS Source
+
+Set an `AWS_LOCAL_PROFILE` environment variable to the AWS local profile you want to use for the benchmark.
+
+For example, if your AWS credentials files looks like this:
+
+```toml
+[default]
+aws_access_key_id = YOUR_ACCESS_KEY_ID
+aws_secret_access_key = YOUR_SECRET_ACCESS_KEY
+
+[benchmark]
+aws_access_key_id = YOUR_ACCESS_KEY_ID
+aws_secret_access_key = YOUR_SECRET_ACCESS_KEY
+```
+
+Then you can set the `AWS_LOCAL_PROFILE` environment variable to `benchmark` to use the `benchmark` profile, via:
+
+```bash
+export AWS_LOCAL_PROFILE=benchmark
+```
+
+Alternatively, you can set the `AWS_LOCAL_PROFILE` environment variable in the `bench_configs/source_aws.yml` file.
+
+### Azure Source
+
+1. Follow the instructions in [Azure Source](https://hub.cloudquery.io/plugins/source/cloudquery/azure/latest/docs#overview-authentication-with-environment-variables) to authenticate with Azure using environment variables.
+2. Set an `AZURE_SUBSCRIPTION_ID` environment variable to the Azure subscription ID you want to use for the benchmark, for example:
+
+```bash
+export AZURE_SUBSCRIPTION_ID=YOUR_AZURE_SUBSCRIPTION_ID
+```
+
+### GCP Source
+
+1. Ensure you have the Google Cloud CLI installed and run `gcloud auth application-default login` to set up Application Default Credentials.
+2. Set an `GCP_PROJECT_ID` environment variable to the GCP project ID you want to use for the benchmark, for example:
+
+```bash
+export GCP_PROJECT_ID=YOUR_GCP_PROJECT_ID
+```
+
+### S3 Destination
+
+To enable sending data to S3, set the following environment variables:
+
+```bash
+export S3_BUCKET_NAME=YOUR_S3_BUCKET_NAME
+export S3_REGION=YOUR_S3_REGION
+export S3_LOCAL_PROFILE=YOUR_S3_LOCAL_PROFILE
+```
+
+## Running the benchmark
+
+```bash
+pip install -r requirements.txt
+python benchmark.py
+```
+
+### Advanced configuration
+
+To generate enough resources to sync, we use the `CQ_DEBUG_SYNC_MULTIPLIER` to simulate more API calls to AWS, GCP and Azure.
+You can update the code to generate more or less resources if you'd like.