{"id":19347170,"url":"https://github.com/dcos/shakedown","last_synced_at":"2025-06-30T14:06:20.215Z","repository":{"id":68916838,"uuid":"52124146","full_name":"dcos/shakedown","owner":"dcos","description":"DC/OS test harness","archived":false,"fork":false,"pushed_at":"2020-01-17T13:36:31.000Z","size":511,"stargazers_count":28,"open_issues_count":0,"forks_count":24,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-09-22T02:17:24.639Z","etag":null,"topics":["dcos","dcos-testing-guild"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dcos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-19T23:47:51.000Z","updated_at":"2024-06-18T17:05:45.000Z","dependencies_parsed_at":"2024-06-21T14:29:43.447Z","dependency_job_id":null,"html_url":"https://github.com/dcos/shakedown","commit_stats":{"total_commits":348,"total_committers":21,"mean_commits":"16.571428571428573","dds":0.6896551724137931,"last_synced_commit":"e2f9e2382788dbcd29bd18aa058b76e7c3b83b3e"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcos%2Fshakedown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcos%2Fshakedown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcos%2Fshakedown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcos%2Fshakedown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dcos","download_url":"https://codeload.github.com/dcos/shakedown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223909905,"owners_count":17223592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dcos","dcos-testing-guild"],"created_at":"2024-11-10T04:14:35.755Z","updated_at":"2024-11-10T04:14:36.364Z","avatar_url":"https://github.com/dcos.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shakedown [![Build Status](http://jenkins.mesosphere.com/service/jenkins/buildStatus/icon?job=public-shakedown-master)](http://jenkins.mesosphere.com/service/jenkins/job/public-shakedown-master/)\n\nDC/OS test harness.\n\n\n## Overview\n\n*A shakedown is a period of testing or a trial journey undergone by a ship, aircraft or other craft and its crew before being declared operational.\n    — https://en.wikipedia.org/wiki/Shakedown_(testing)*\n\n\n## Installation\n\nShakedown requires Python 3.4+.\n\n### Installing from PyPI\n\nThe recommended Shakedown installation method is via the PyPI Python Package Index repository at [https://pypi.python.org/pypi/dcos-shakedown](https://pypi.python.org/pypi/dcos-shakedown).  To install the latest version and all required modules:\n\n`pip3 install dcos-shakedown`\n\ndcos-shakedown has a number of dependencies which need to be available.  One of those dependencies, the cryptography module requires a number of OS level libraries in order to install correctly which include: `build-essential libssl-dev libffi-dev python-dev`.  For environments other than linux please read [Stackoverflow](http://stackoverflow.com/questions/22073516/failed-to-install-python-cryptography-package-with-pip-and-setup-py). On a new ubuntu environment the following should install dcos-shakedown.\n\n* `apt-get update`\n* `apt-get install python3 python3-pip build-essential libssl-dev libffi-dev python-dev`\n* `pip3 install dcos-shakedown`\n\n### Development and bleeding edge\n\nTo pull and install from our `master` branch on GitHub:\n\n```\ngit clone https://github.com/dcos/shakedown.git\ncd shakedown\npip3 install -r requirements.txt \u0026\u0026 pip3 install -e .\n```\n\nOr if you do not wish to pin to a version of `dcos-cli`:\n\n```\npip3 install -r requirements-edge.txt \u0026\u0026 pip3 install -e .\n```\n\n### Setting up a new Shakedown virtual environment\n\nIf you'd like to isolate your Shakedown Python environment, you can do so using the [virtualenv](https://pypi.python.org/pypi/virtualenv) tool.  To create a new virtual environment in `$HOME/shakedown`:\n\n```\npip3 install virtualenv\nvirtualenv $HOME/shakedown\nsource $HOME/shakedown/bin/activate\npip3 install dcos-shakedown\n```\n\nThis virtual environment can then be activated in new terminal sessions with:\n\n`source $HOME/shakedown/bin/activate`\n\n\n## Usage\n\n`shakedown --dcos-url=http://dcos.example.com [options] [path_to_tests]`\n\n- `--dcos-url` is required.\n- tests within the current working directory will be auto-discovered unless specified.\n- arguments can be stored in a `~/.shakedown` [TOML](https://github.com/toml-lang/toml) file (command-line takes precedence)\n- `shakedown --help` is your friend.\n\n\n### Running in parallel\n\nShakedown can be run against multiple DC/OS clusters in parallel by setting the `DCOS_CONFIG_ENV` environmental variable to a unique file, eg:\n\n`DCOS_CONFIG_ENV='shakedown-custom-01.toml' shakedown --dcos-url=http://dcos.example.com [options] [path_to_tests]`\n\n\n## Helper methods\n\nShakedown is a testing tool as well as a library.  Many helper functions are available via `from shakedown import *` in your tests.  See the [API documentation](API.md) for more information.\n\n\n## License\n\nShakedown is licensed under the Apache License, Version 2.0.  For additional information, see the [LICENSE](LICENSE) file included at the root of this repository.\n\n\n## Reporting issues\n\nPlease report issues and submit feature requests for Shakedown by [creating an issue in the DC/OS JIRA with the \"Shakedown\" component](https://jira.mesosphere.com/secure/CreateIssueDetails!init.jspa?pid=14105\u0026components=19807\u0026issuetype=3) (JIRA account required).\n\n\n## Contributing\n\nSee the [CONTRIBUTING](CONTRIBUTING.md) file in the root of this repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcos%2Fshakedown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdcos%2Fshakedown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcos%2Fshakedown/lists"}