Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
sunbro1337 committed Jul 17, 2022
1 parent 7115724 commit 5a71ff5
Show file tree
Hide file tree
Showing 4 changed files with 150 additions and 129 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
configs/client_config.yaml
src/testrail/__pycache__
test_cases/*
.cache/*
cache/*
hooks/hooks_support/__pycache__
__pycache__
*/__pycache__
149 changes: 21 additions & 128 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,128 +1,21 @@
# Casesync, gitgud

## Workflow for this repo
- create branch with commit
- update readme with commit
- complete task with commit
- update readme with commit
- pull request for branch with branch notes


## Useful links

- https://www.gurock.com/testrail/docs/api/getting-started/binding-python/
- https://docs.gitlab.com/ee/ci/test_cases/
- https://www.gurock.com/testrail/github-test-management
- https://blog.gurock.com/test-version-control/
- https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks


### Json, Yaml
- https://stackabuse.com/reading-and-writing-yaml-to-a-file-in-python/
- https://stackabuse.com/reading-and-writing-json-to-a-file-in-python/


## Improves:

### Docs

- git guide
- how to write ci scripts
- how to write cases
- casesync guide

### Git

- buy gitlab for qa or develop hooks for bitbacket(more pain!)
- configure gitlab for users groups
- trigger jenkins with bitbucket webhook > jenkins get diff from bitbacket after triggered
- improves for GitPython functions
- Use permissions and roles for users groups: https://docs.gitlab.com/ee/user/profile/
- implement gitlab server hooks
- create test-design branch with dev branch
- last branch label in case


### Testrail

- research testrail version system https://blog.gurock.com/test-version-control/
- write docs for testrail lib
- sync comments for cases_methods with testrail api doc
- Support the ID of the parent section (to build section hierarchies)
- support adding attach files for cases
- Git bot(client) for test rail
- link git branch to task in jira


### Tech

- cache system improvements
- post cases with hook(firstly collect dirs for sections/suites, secondly cases) relative to last cases commit
- implement install.py script for casesync system:
- check and update local hooks



### Test design

- Create test cases extension for code redactor(vs studio code)


## In progress

-


## Done:

### Git

- research git hooks:
- https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
- https://developer.atlassian.com/server/framework/atlassian-sdk/set-up-the-atlassian-plugin-sdk-and-build-a-project/
- https://docs.gitlab.com/ee/administration/server_hooks.html
- research GitPython lib:
- https://gitpython.readthedocs.io/en/stable/tutorial.html#obtaining-diff-information
- research gitlab runners:
- https://docs.gitlab.com/runner/
- https://docs.gitlab.com/runner/install/windows.html
- research and create gitlab self-management server:
- https://about.gitlab.com/install/#ubuntu,
- https://embeddedinventor.com/complete-guide-to-setting-up-gitlab-locally-on-windows-pc/#STEP5_Download_and_install_GitLab_server
- migrate to gitlab
- configure Gitlab runners:
- https://docs.gitlab.com/runner/shells/index.html#shell-profile-loading
- https://docs.gitlab.com/ee/ci/runners/configure_runners.html
- https://docs.gitlab.com/ee/ci/pipelines/merge_request_pipelines.html
- https://stackoverflow.com/questions/70654510/how-to-run-pipeline-after-merge-request-approved-in-gitlab-ci
- write scripts for runners:
- https://gitpython.readthedocs.io/en/stable/tutorial.html#
- https://python-gitlab.readthedocs.io/en/stable/index.html
- https://forum.gitlab.com/t/ci-cd-pipeline-get-list-of-changed-files/26847/23
- https://docs.gitlab.com/ee/ci/variables/
- https://stackoverflow.com/questions/3636914/how-can-i-see-what-i-am-about-to-push-with-git
- https://git-scm.com/docs/git-ls-remote.html
- https://stackoverflow.com/questions/10991639/using-gitpython-module-to-get-remote-head-branch
- https://en.wikipedia.org/wiki/Shebang_(Unix)
- https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project
- https://www.codetd.com/en/article/12143066


### Testrail

- research testrail api
- first testrail api implements
- manipulations with cases
- login with api key: https://www.gurock.com/testrail/docs/api/getting-started/accessing/


### Tech

- testcase file format(yml, json)
- download all case base and save it in a test-case format
- class TMSProject
- testcase system for test design
- log system or lib
- refactor create local case base
- cache system minimal
- create dir for empty sections/suites
## Roles for working with the system:
- Test Developer - an engineer who uses the system to develop
tests.
- CI script developer - an engineer who develops and
configures CI pipeline for tests.
- System developer - an engineer who develops the system infrastructure
and the system itself.


## Install

*SOON*


## Docs

*SOON*

## Screenshots

*SOON*
File renamed without changes.
128 changes: 128 additions & 0 deletions docs/notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Casesync, gitgud

## Workflow for this repo
- create branch with commit
- update readme with commit
- complete task with commit
- update readme with commit
- pull request for branch with branch notes


## Useful links

- https://www.gurock.com/testrail/docs/api/getting-started/binding-python/
- https://docs.gitlab.com/ee/ci/test_cases/
- https://www.gurock.com/testrail/github-test-management
- https://blog.gurock.com/test-version-control/
- https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks


### Json, Yaml
- https://stackabuse.com/reading-and-writing-yaml-to-a-file-in-python/
- https://stackabuse.com/reading-and-writing-json-to-a-file-in-python/


## Improves:

### Docs

- git guide
- how to write ci scripts
- how to write cases
- casesync guide

### Git

- buy gitlab for qa or develop hooks for bitbacket(more pain!)
- configure gitlab for users groups
- trigger jenkins with bitbucket webhook > jenkins get diff from bitbacket after triggered
- improves for GitPython functions
- Use permissions and roles for users groups: https://docs.gitlab.com/ee/user/profile/
- implement gitlab server hooks
- create test-design branch with dev branch
- last branch label in case


### Testrail

- research testrail version system https://blog.gurock.com/test-version-control/
- write docs for testrail lib
- sync comments for cases_methods with testrail api doc
- Support the ID of the parent section (to build section hierarchies)
- support adding attach files for cases
- Git bot(client) for test rail
- link git branch to task in jira


### Tech

- cache system improvements
- post cases with hook(firstly collect dirs for sections/suites, secondly cases) relative to last cases commit
- implement install.py script for casesync system:
- check and update local hooks



### Test design

- Create test cases extension for code redactor(vs studio code)


## In progress

-


## Done:

### Git

- research git hooks:
- https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
- https://developer.atlassian.com/server/framework/atlassian-sdk/set-up-the-atlassian-plugin-sdk-and-build-a-project/
- https://docs.gitlab.com/ee/administration/server_hooks.html
- research GitPython lib:
- https://gitpython.readthedocs.io/en/stable/tutorial.html#obtaining-diff-information
- research gitlab runners:
- https://docs.gitlab.com/runner/
- https://docs.gitlab.com/runner/install/windows.html
- research and create gitlab self-management server:
- https://about.gitlab.com/install/#ubuntu,
- https://embeddedinventor.com/complete-guide-to-setting-up-gitlab-locally-on-windows-pc/#STEP5_Download_and_install_GitLab_server
- migrate to gitlab
- configure Gitlab runners:
- https://docs.gitlab.com/runner/shells/index.html#shell-profile-loading
- https://docs.gitlab.com/ee/ci/runners/configure_runners.html
- https://docs.gitlab.com/ee/ci/pipelines/merge_request_pipelines.html
- https://stackoverflow.com/questions/70654510/how-to-run-pipeline-after-merge-request-approved-in-gitlab-ci
- write scripts for runners:
- https://gitpython.readthedocs.io/en/stable/tutorial.html#
- https://python-gitlab.readthedocs.io/en/stable/index.html
- https://forum.gitlab.com/t/ci-cd-pipeline-get-list-of-changed-files/26847/23
- https://docs.gitlab.com/ee/ci/variables/
- https://stackoverflow.com/questions/3636914/how-can-i-see-what-i-am-about-to-push-with-git
- https://git-scm.com/docs/git-ls-remote.html
- https://stackoverflow.com/questions/10991639/using-gitpython-module-to-get-remote-head-branch
- https://en.wikipedia.org/wiki/Shebang_(Unix)
- https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project
- https://www.codetd.com/en/article/12143066


### Testrail

- research testrail api
- first testrail api implements
- manipulations with cases
- login with api key: https://www.gurock.com/testrail/docs/api/getting-started/accessing/


### Tech

- testcase file format(yml, json)
- download all case base and save it in a test-case format
- class TMSProject
- testcase system for test design
- log system or lib
- refactor create local case base
- cache system minimal
- create dir for empty sections/suites

0 comments on commit 5a71ff5

Please sign in to comment.