{"id":22856626,"url":"https://github.com/deis/workflow-e2e","last_synced_at":"2025-04-30T15:13:46.242Z","repository":{"id":71905617,"uuid":"48503688","full_name":"deis/workflow-e2e","owner":"deis","description":"End-to-end tests for Deis Workflow","archived":false,"fork":false,"pushed_at":"2018-10-06T14:39:42.000Z","size":18321,"stargazers_count":12,"open_issues_count":14,"forks_count":18,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-30T17:12:02.537Z","etag":null,"topics":["deis-workflow","end-to-end-testing","ginkgo","k8s","kubernetes","unsupported"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deis.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2015-12-23T17:50:37.000Z","updated_at":"2023-08-21T14:40:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"32cd457b-b806-4d32-ba15-1bbc9c85494f","html_url":"https://github.com/deis/workflow-e2e","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deis%2Fworkflow-e2e","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deis%2Fworkflow-e2e/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deis%2Fworkflow-e2e/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deis%2Fworkflow-e2e/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deis","download_url":"https://codeload.github.com/deis/workflow-e2e/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251729733,"owners_count":21634281,"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":["deis-workflow","end-to-end-testing","ginkgo","k8s","kubernetes","unsupported"],"created_at":"2024-12-13T08:09:16.670Z","updated_at":"2025-04-30T15:13:46.209Z","avatar_url":"https://github.com/deis.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n|![](https://upload.wikimedia.org/wikipedia/commons/thumb/1/17/Warning.svg/156px-Warning.svg.png) | Deis Workflow is no longer maintained.\u003cbr /\u003ePlease [read the announcement](https://deis.com/blog/2017/deis-workflow-final-release/) for more detail. |\n|---:|---|\n| 09/07/2017 | Deis Workflow [v2.18][] final release before entering maintenance mode |\n| 03/01/2018 | End of Workflow maintenance: critical patches no longer merged |\n| | [Hephy](https://github.com/teamhephy/workflow) is a fork of Workflow that is actively developed and accepts code contributions. |\n\n# Deis Workflow End to End Tests v2\n\n[![Build Status](https://ci.deis.io/job/workflow-e2e/badge/icon)](https://ci.deis.io/job/workflow-e2e)\n[![Go Report Card](https://goreportcard.com/badge/github.com/deis/workflow-e2e)](https://goreportcard.com/report/github.com/deis/workflow-e2e)\n[![Docker Repository on Quay](https://quay.io/repository/deisci/deis-e2e/status \"Docker Repository on Quay\")](https://quay.io/repository/deisci/deis-e2e)\n\nDeis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes](http://kubernetes.io) cluster, making it easy to deploy and manage applications on your own servers.\n\nFor more information about the Deis Workflow, please visit the main project page at https://github.com/deis/workflow.\n\nWe welcome your input! If you have feedback, please [submit an issue][issues]. If you'd like to participate in development, please read the \"Development\" section below and [submit a pull request][prs].\n\n# About\n\nThe code in this repository is a set of [Ginkgo](http://onsi.github.io/ginkgo) and [Gomega](http://onsi.github.io/gomega) based integration tests that execute commands against a running Deis cluster using the Deis CLI.\n\n# Development\n\nThe Deis project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.\n\n* Fork this repository\n* Make your changes\n* [Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible.\n  * If your PR fixes any [issues][issues], make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing)\n* The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with LGTM1 and LGTM2 (respectively). Once that happens, the contributors will merge it\n\n## Prerequisities\n\nBefore you run the tests, you'll need a full Deis cluster up and running in Kubernetes. Follow the instructions [here](https://github.com/deis/charts#installation) to get one running.\n\n## Run the Tests\n\nThere are three options for how to execute the tests. These include two options for executing the tests against Deis Workflow installed on a _remote_ Kubernetes cluster, and one option for installing the same tests directly into a Kubernetes cluster and executing them there.\n\n### Remote Execution\n\nEither of two options for remote execution of the test suite require the `DEIS_CONTROLLER_URL` environment variable to be exported. Its value should be the the controller endpoint you would normally use with the `deis register` or `deis login` commands:\n\n```console\n$ export DEIS_CONTROLLER_URL=http://deis.your.cluster\n```\n\nTests execute in parallel by default. If you wish to control the number of executors, export a value for the `GINKGO_NODES` environment variable:\n\n```console\n$ export GINKGO_NODES=5\n```\n\nIf this is not set, Ginkgo will automatically choose a number of test nodes (executors) based on the number of CPU cores _on the machine executing the tests_. It is important to note, however, that test execution is constrained more significantly by the resources of the cluster under test than by the resources of the machine executing the tests. The number of test nodes, therefore, should be explicitly set and scaled in proportion to the resources available in the cluster.\n\nFor reference, Workflow's own CI pipeline uses the following:\n\n| Test Nodes | Kubernetes Worker Nodes | Worker Node CPU | Worker Node Memory |\n|------------|-------------------------|-----------------|--------------------|\n| 5          | 3                       | 4 vCPUs         | 15 GB              |\n\nSetting the `GINKGO_NODES` environment variable to a value of `1` will allow serialized execution of all tests in the suite.\n\n#### Native Execution\n\nIf you have Go 1.5 or greater already installed and working properly and also have the [Glide](https://github.com/Masterminds/glide) dependency management tool for Go installed, you may clone this repository into your `$GOPATH`:\n\n```console\ngit clone git@github.com:deis/workflow-e2e.git $GOPATH/src/github.com/deis/workflow-e2e\n```\n\nOne-time execution of the following will resolve the test suite's own dependencies:\n\n```console\n$ make bootstrap\n```\n\nTo execute the entire test suite:\n\n```console\n$ make test-integration\n```\n\nTo run a single test or set of tests, you'll need the [Ginkgo](https://github.com/onsi/ginkgo) tool installed on your machine:\n\n```console\n$ go get github.com/onsi/ginkgo/ginkgo\n```\n\nYou can then use the `--focus` option to run subsets of the test suite:\n\n```console\n$ ginkgo --focus=\"deis apps\" tests\n```\n\n#### Containerized Execution\n\nIf you do not have Go 1.5 or greater installed locally, but do have a Docker daemon running locally (or are using docker-machine), you can quite easily execute tests against a remote cluster from within a container.\n\nIn this case, you may clone this repository into a path of your own choosing (does not need to be on your `$GOPATH`):\n\n```console\ngit clone git@github.com:deis/workflow-e2e.git /path/of/your/choice\n```\n\nThen build the test image and execute the test suite:\n\n```console\n$ make docker-build docker-test-integration\n```\n\n### Within the Cluster\n\nA third option is to run the test suite from within the very cluster that is under test.\n\nTo install the [helm](https://github.com/kubernetes/helm) chart and start the tests, assuming helm and its corresponding server component tiller are [installed](https://github.com/kubernetes/helm/blob/master/docs/install.md):\n\n```console\nhelm repo add workflow-e2e https://charts.deis.com/workflow-e2e\nhelm install --verify workflow-e2e/workflow-e2e --namespace deis\n```\n\nTo monitor tests as they execute:\n\n```console\n$ kubectl --namespace=deis logs -f workflow-e2e tests\n```\n\n## Special Note on Resetting Cluster State\n\nAll tests clean up after themselves, however, in the case of test failures or interruptions, automatic cleanup may not always proceed as intended. This may leave projects, users or other state behind, which may impact future executions of the test suite against the same cluster. (Often all tests will fail.) If you see this behavior, run these commands to clean up. (Replace `deis-workflow-qoxhz` with the name of the deis/workflow pod in your cluster.)\n\n```console\n$ kubectl exec -it deis-workflow-qoxhz python manage.py shell\nPython 2.7.10 (default, Aug 13 2015, 12:27:27)\n[GCC 4.9.2] on linux2\n\u003e\u003e\u003e from django.contrib.auth import get_user_model\n\u003e\u003e\u003e m = get_user_model()\n\u003e\u003e\u003e m.objects.exclude(username='AnonymousUser').delete()\n\u003e\u003e\u003e m.objects.all()\n```\n\nNote that this is an ongoing issue for which we're planning [a more comprehensive fix](https://github.com/deis/workflow-e2e/issues/12).\n\n\n[install-k8s]: http://kubernetes.io/gettingstarted/\n[issues]: https://github.com/deis/workflow-e2e/issues\n[prs]: https://github.com/deis/workflow-e2e/pulls\n[v2.18]: https://github.com/deis/workflow/releases/tag/v2.18.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeis%2Fworkflow-e2e","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeis%2Fworkflow-e2e","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeis%2Fworkflow-e2e/lists"}