{"id":18689691,"url":"https://github.com/mrseanryan/screenium","last_synced_at":"2025-11-08T07:30:30.427Z","repository":{"id":96809986,"uuid":"239348652","full_name":"mrseanryan/screenium","owner":"mrseanryan","description":"A console tool to automatically test web sites [SCREENshots via selenIUM]","archived":false,"fork":false,"pushed_at":"2023-10-18T23:13:03.000Z","size":6530,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-28T01:49:32.287Z","etag":null,"topics":["automated-testing","integration-testing","screenshot","screenshot-testing","screenshot-tests"],"latest_commit_sha":null,"homepage":"","language":"C#","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/mrseanryan.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","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":"2020-02-09T17:58:50.000Z","updated_at":"2020-02-09T18:04:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"8fcbeeb3-ad19-44f7-a9d9-e93f02019b3c","html_url":"https://github.com/mrseanryan/screenium","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrseanryan%2Fscreenium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrseanryan%2Fscreenium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrseanryan%2Fscreenium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrseanryan%2Fscreenium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrseanryan","download_url":"https://codeload.github.com/mrseanryan/screenium/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239550286,"owners_count":19657541,"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","integration-testing","screenshot","screenshot-testing","screenshot-tests"],"created_at":"2024-11-07T10:44:47.066Z","updated_at":"2025-11-08T07:30:30.380Z","avatar_url":"https://github.com/mrseanryan.png","language":"C#","readme":"screenium\r\n=========\r\n\r\n\r\n![screenium_icon_45w.png](https://bitbucket.org/repo/rzKA8y/images/436353880-screenium_icon_45w.png)\r\nscreenium = a console tool to automatically test web sites\r\n\r\n- easy to configure (just a CSV file containing URLs)\r\n\r\n- compares screenshots taken via Selenium WebDriver\r\n\r\n- easy to update your 'expected' screenshots\r\n\r\n- spend less time testing, and more time coding!\r\n\r\n- browsers: currently Google Chrome only\r\n\r\n- integration with your application is via URLs only - suitable for SPA or similar...\r\n\r\n   |       \r\n-----|------\r\nsample report | ![sample_report_screenshot.PNG](https://bitbucket.org/repo/rzKA8y/images/1379854876-sample_report_screenshot.PNG)\r\n\r\nLicense\r\n=======\r\nThe MIT License (MIT)\r\n\r\n- screenium code written by Sean Ryan.\r\n\r\n- uses 3rd party DLLs (see Dependencies section).\r\n\r\nHow To Use screenium\r\n====================\r\n1 - install the dependencies (see below)\r\n\r\n2 - build the source code using Visual Studio 2013 or later\r\n\r\n3 - run the self-test to make sure that everything is working OK\r\n\r\nrun_self_test.bat\r\n\r\n4 - configure the CSV file\r\n\r\nsee example CSV: \r\n\r\nscreenium\\TestData\\testGoogleHome.csv\r\n\r\n5 - run the console tool to save 'expected' images\r\n\r\nsee example BAT file:\r\n\r\nrun_google_home_save.bat\r\n\r\n6 - run the console tool to compare 'actual' web site, to the saved 'expected' images\r\n\r\nsee example BAT file: \r\n\r\nrun_google_home.bat\r\n\r\nA simple text report is output:\r\n\r\n```\r\n#!BAT\r\nTest Results:\r\nGoogle search by image page\r\nResult: Different\r\nTolerance: 0.01\r\nDistortion: 0.0546446136539016\r\nFinished running tests [OK]\r\n```\r\n\r\nFor manual inspection, a report containing difference images is generated.\r\nFor integration with a build, the console returns error codes as standard.\r\n\r\nUsage From Console\r\n==================\r\nTo see the arguments and options, simply type:\r\n\r\n\r\n```\r\n#!BAT\r\n\r\n screenium\r\n```\r\n\r\n and press ENTER:\r\n \r\n\r\n```\r\n#!BAT\r\n\r\nscreenium 1.2.0.0\r\nUsage: \u003cCSV_FILE_PATH\u003e \u003cTEST_NAME\u003e \u003cOUTPUT_FILE_PATH\u003e \u003cIMAGES_DIR_PATH\u003e \u003cTEMPLATES_DIR_PATH\u003e \u003cOPTIONS\u003e\r\nOptions:\r\n-r = Run\r\n-s = Save\r\n-t = TestSelf\r\n-a = AcceptChanges\r\n-v = Verbose\r\n-q = QuietNotShowResults\r\n```\r\n\r\n\r\nDependencies\r\n============\r\n- Visual Studio 2013\r\n- Chrome web browser\r\n\r\n- Selenium WebDriver\r\nnuget: Selenium.WebDriver\r\nversion: 2.46.0\r\n\r\nnuget: WebDriver.Support\r\n\r\n- Image Magick.NET\r\nnuget: Magick.NET-Q16-AnyCPU\r\n\r\n- ChromeDriver [is included in source code]\r\nversion: 2.20 [but its best to use the latest one!]\r\nhttps://sites.google.com/a/chromium.org/chromedriver/downloads\r\nhttp://chromedriver.storage.googleapis.com/index.html\r\n\r\n- VS C++ 2015 Redistributable [for Image Magick.NET]\r\nx86 AND x64\r\nhttp://www.microsoft.com/en-us/download/details.aspx?id=48145\r\n\r\n- docfx\r\nnuget package: docfx.msbuild\r\n\r\n\r\nReferences\r\n==========\r\n\r\nhow-to:\r\n-------\r\nhttp://www.jimmycollins.org/blog/?p=466\r\n\r\nC# API:\r\n-------\r\nhttp://seleniumhq.github.io/selenium/docs/api/dotnet/index.html\r\n\r\nSelenium WebDriver nuget package:\r\n---------------------------------\r\nSelenium.WebDriver\r\n\r\nhttp://www.seleniumhq.org/docs/03_webdriver.jsp\r\n\r\nhttp://www.seleniumhq.org/docs/03_webdriver.jsp#chromedriver \r\n \r\nchrome driver\r\n-------------\r\nhttps://sites.google.com/a/chromium.org/chromedriver/\r\n\r\nhttps://sites.google.com/a/chromium.org/chromedriver/getting-started\r\n\r\nhttps://github.com/SeleniumHQ/selenium/wiki/ChromeDriver\r\n\r\nSelenium WebDriver \u0026 chromedriver\r\n---------------------------------\r\nWebDriver works with Chrome through the chromedriver binary (found on the chromium project download page). You need to have both chromedriver and a version of chrome browser installed.\r\n\r\nchromedriver needs to be placed somewhere on your system path in order for WebDriver to automatically discover it.\r\n\r\nThe Chrome browser itself is discovered by chromedriver in the default installation path.\r\nThese both can be overridden by environment variables. \r\nPlease refer to the wiki for more information:\r\nhttps://github.com/SeleniumHQ/selenium/wiki/ChromeDriver\r\n\r\nAuto generated API docs - GhostDoc\r\n----------------------------------\r\nThis help file was generated with the *free* edition of GhostDoc (a VS extension):\r\ndocs\\Help\\screenium.chm\r\n\r\nref:\r\nhttp://submain.com/products/ghostdoc.aspx\r\n\r\nAuto generated API docs - docfx\r\n-------------------------------\r\n- when built in *Release* config, screenium project uses the docfx tool to generate API docs.\r\n\r\nGhostDoc is probably better, but on the other hand, docfx installs itself via nuget,\r\nand runs out-of-the-box as part of the build.\r\n\r\nref:\r\nhttp://aspnet.github.io/docfx/tutorial/docfx.exe_user_manual.html\r\n\r\nnuget package: docfx.msbuild\r\n\r\nnotes:\r\n- only *public* types and methods are documented\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrseanryan%2Fscreenium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrseanryan%2Fscreenium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrseanryan%2Fscreenium/lists"}