{"id":25473416,"url":"https://github.com/SuffolkLITLab/ALKiln","last_synced_at":"2025-11-05T06:30:39.937Z","repository":{"id":37666701,"uuid":"302790740","full_name":"SuffolkLITLab/ALKiln","owner":"SuffolkLITLab","description":"Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.","archived":false,"fork":false,"pushed_at":"2025-01-11T15:03:56.000Z","size":3995,"stargazers_count":14,"open_issues_count":44,"forks_count":4,"subscribers_count":6,"default_branch":"v5","last_synced_at":"2025-02-06T14:13:29.245Z","etag":null,"topics":["automated-testing","cucumberjs","docassemble","document-assembly-line","integrated-testing","opensource","puppeteer"],"latest_commit_sha":null,"homepage":"https://assemblyline.suffolklitlab.org/docs/alkiln/intro","language":"JavaScript","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/SuffolkLITLab.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-10T01:41:30.000Z","updated_at":"2025-01-20T12:39:59.000Z","dependencies_parsed_at":"2023-12-18T18:15:12.115Z","dependency_job_id":"58ad689b-0935-446d-8605-535d315ebf5a","html_url":"https://github.com/SuffolkLITLab/ALKiln","commit_stats":{"total_commits":800,"total_committers":11,"mean_commits":72.72727272727273,"dds":"0.13124999999999998","last_synced_commit":"e21fb4157389740e27d62a31513e641d2d6842ca"},"previous_names":["plocket/docassemble-cucumber"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FALKiln","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FALKiln/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FALKiln/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FALKiln/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SuffolkLITLab","download_url":"https://codeload.github.com/SuffolkLITLab/ALKiln/tar.gz/refs/heads/v5","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238927146,"owners_count":19553617,"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":["automated-testing","cucumberjs","docassemble","document-assembly-line","integrated-testing","opensource","puppeteer"],"created_at":"2025-02-18T10:21:04.258Z","updated_at":"2025-11-05T06:30:39.887Z","avatar_url":"https://github.com/SuffolkLITLab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ALKiln\n\nALKiln, or Assembly Line Kiln, is an open source project that helps [docassemble](https://docassemble.org/) developers create automated tests for their interviews (online forms). It works well with the [Document Assembly Line Project](https://suffolklitlab.org/docassemble-AssemblyLine-documentation) but isn't dependent on it.\n\n\u003c!-- \nhttps://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md\n√ What is this repo or project? (You can reuse the repo description you used earlier because this section doesn’t have to be long.)\n√ How does it work?\n√ Who will use this repo or project?\n√ What is the goal of this project?\n--\u003e\n\n## Use ALKiln\n\nRead about how to use [this framework in Assembly Line's documentation](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/intro).\n\nIf you have questions or need to report a bug, [start a new issue](https://github.com/SuffolkLITLab/ALKiln/issues/new).\n\nThe following documentation is for internal developers—those working on ALKiln itself.\n\n## Our code\n\nOur code pretends to be a human interacting with online forms (interviews) that have been made with the [docassemble](https://docassemble.org) open source platform. It looks at the HTML DOM, manipulates it, and interacts with it.\n\nIt uses [cucumber](https://cucumber.io/docs/installation/javascript/), [puppeteer](https://pptr.dev/), and [chai](https://www.chaijs.com/).\n\n## Our users\n\nOur users are developers of online forms (interviews). Usually they're very new to coding and are unfamiliar with GitHub and with a lot of coding concepts. If they know how to code, it tends to be in Python because that's what docassemble uses. They usually don't have the resource or funding to put into learning these skills.\n\nFor example, a pro bono law firm is trying to write a form that people can use to create a restraining order. They're coding it using docassemble. Their users are already going through a hard time, and the forms make them outline their heart wrenching experiences in detail. The developers need to make sure their users don't get system errors right in the middle of that. They use our framework to run the end-to-end tests.\n\nThey do good work and we hope to give them a less code-focused way to automate their testing. They avoid having to learn Javascript, GitHub actions, and other such things.\n\nTo do that, we use [cucumberjs](https://cucumber.io/docs/installation/javascript/), which uses [Gherkin](https://cucumber.io/docs/gherkin/reference/) syntax to give a user/developer a more human-like syntax to instruct alkiln on what answers to give to the user's online form.\n\n## Contributing\n\nRead about contributing in our [CONTRIBUTING.md document](CONTRIBUTING.md). Here's a quick cheat sheet for some commands once you're up and running:\n\n## Cheat sheet\n\n*Once you've already read the contributing documentation, you can use these as quick reminders for running our internal tests.*\n\n### `setup` before starting development of a feature/fix\n\nSet up for the cucumber integration tests.\n\nAdd the feature branch name to your `.env` file:\n\n```\nBRANCH=42_feat_life_the_univers_and_everything\n```\n\nThen create the project on the server:\n\n```bash\nnpm run setup\n```\n\n### Run tests repeatedly\n\nRun all cucumber tests that are not currently blocked by upstream changes:\n\n```bash\nnpm run pass\n```\n\nTrigger cucumber tests with specific tags:\n\n```bash\nnpm run cucumber \"@tagname\"\n```\n\nRun the unit tests:\n\n```bash\nnpm run unit\n```\n\n### Always run `takedown` before running `setup` again\n\nIf you or someone else changes the interview code in our `./docassemble` directory, you have to delete the code currently on the testing server before running `setup` again. Also do this when you're done with the feature/fix or starting a new feature/fix.\n\n```bash\nnpm run takedown\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSuffolkLITLab%2FALKiln","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSuffolkLITLab%2FALKiln","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSuffolkLITLab%2FALKiln/lists"}