2025-01-23 15:49:19 +00:00
<!doctype html>
< html lang = "en" dir = "ltr" class = "docs-wrapper plugin-docs plugin-id-tutorial docs-version-current docs-doc-page docs-doc-id-testcontainers-with-podman" data-has-hydrated = "false" >
< head >
< meta charset = "UTF-8" >
2025-11-05 20:28:25 +00:00
< meta name = "generator" content = "Docusaurus v3.9.2" >
2025-09-08 13:08:00 +00:00
< title data-rh = "true" > Testcontainers with Podman | Podman Desktop< / title > < meta data-rh = "true" name = "viewport" content = "width=device-width,initial-scale=1" > < meta data-rh = "true" name = "twitter:card" content = "summary_large_image" > < meta data-rh = "true" property = "og:image" content = "https://podman-desktop.io/img/banner_podman-desktop.png" > < meta data-rh = "true" name = "twitter:image" content = "https://podman-desktop.io/img/banner_podman-desktop.png" > < meta data-rh = "true" property = "og:url" content = "https://podman-desktop.io/tutorial/testcontainers-with-podman" > < meta data-rh = "true" property = "og:locale" content = "en" > < meta data-rh = "true" name = "docusaurus_locale" content = "en" > < meta data-rh = "true" name = "docsearch:language" content = "en" > < meta data-rh = "true" name = "docusaurus_version" content = "current" > < meta data-rh = "true" name = "docusaurus_tag" content = "docs-tutorial-current" > < meta data-rh = "true" name = "docsearch:version" content = "current" > < meta data-rh = "true" name = "docsearch:docusaurus_tag" content = "docs-tutorial-current" > < meta data-rh = "true" property = "og:title" content = "Testcontainers with Podman | Podman Desktop" > < meta data-rh = "true" name = "description" content = "Learn how to use Testcontainers with Podman and how to create basic tests using Testcontainers technology!" > < meta data-rh = "true" property = "og:description" content = "Learn how to use Testcontainers with Podman and how to create basic tests using Testcontainers technology!" > < meta data-rh = "true" name = "keywords" content = "podman,podman-desktop,containers,testcontainers" > < link data-rh = "true" rel = "icon" href = "/img/favicon.ico" > < link data-rh = "true" rel = "canonical" href = "https://podman-desktop.io/tutorial/testcontainers-with-podman" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/tutorial/testcontainers-with-podman" hreflang = "en" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/tutorial/testcontainers-with-podman" hreflang = "x-default" > < link data-rh = "true" rel = "preconnect" href = "https://MR01ANKQ9S-dsn.algolia.net" crossorigin = "anonymous" > < script data-rh = "true" type = "application/ld+json" > { "@context" : "https://schema.org" , "@type" : "BreadcrumbList" , "itemListElement" : [ { "@type" : "ListItem" , "position" : 1 , "name" : "Testcontainers with Podman" , "item" : "https://podman-desktop.io/tutorial/testcontainers-with-podman" } ] } < / script > < link rel = "alternate" type = "application/rss+xml" href = "/blog/rss.xml" title = "Podman Desktop RSS Feed" >
2025-01-23 15:49:19 +00:00
< link rel = "alternate" type = "application/atom+xml" href = "/blog/atom.xml" title = "Podman Desktop Atom Feed" >
< link rel = "alternate" type = "application/json" href = "/blog/feed.json" title = "Podman Desktop JSON Feed" >
< link rel = "search" type = "application/opensearchdescription+xml" title = "Podman Desktop" href = "/opensearch.xml" >
< link rel = "preconnect" href = "https://podman-desktop-website.goatcounter.com" >
2026-03-19 08:37:32 +00:00
< script async src = "//gc.zgo.at/count.js" data-goatcounter = "https://podman-desktop-website.goatcounter.com/count" > < / script > < link rel = "stylesheet" href = "/assets/css/styles.82f9557a.css" >
2026-03-31 12:16:47 +00:00
< script src = "/assets/js/runtime~main.95ea1fd3.js" defer = "defer" > < / script >
2026-03-31 03:37:19 +00:00
< script src = "/assets/js/main.7c4f9f9c.js" defer = "defer" > < / script >
2025-01-23 15:49:19 +00:00
< / head >
< body class = "navigation-with-keyboard" >
2025-11-05 20:28:25 +00:00
< svg style = "display: none;" > < defs >
2025-09-08 13:08:00 +00:00
< symbol id = "theme-svg-external-link" viewBox = "0 0 24 24" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z" / > < / symbol >
< / defs > < / svg >
2026-03-24 10:21:51 +00:00
< script > ! function ( ) { var t = function ( ) { try { return new URLSearchParams ( window . location . search ) . get ( "docusaurus-theme" ) } catch ( t ) { } } ( ) || function ( ) { try { return window . localStorage . getItem ( "theme" ) } catch ( t ) { } } ( ) ; document . documentElement . setAttribute ( "data-theme" , t || ( window . matchMedia ( "(prefers-color-scheme: dark)" ) . matches ? "dark" : "light" ) ) , document . documentElement . setAttribute ( "data-theme-choice" , t || "system" ) } ( ) , function ( ) { try { const c = new URLSearchParams ( window . location . search ) . entries ( ) ; for ( var [ t , e ] of c ) if ( t . startsWith ( "docusaurus-data-" ) ) { var a = t . replace ( "docusaurus-data-" , "data-" ) ; document . documentElement . setAttribute ( a , e ) } } catch ( t ) { } } ( ) < / script > < div id = "__docusaurus" > < div role = "region" aria-label = "Skip to main content" > < a class = "skipToContent_oPtH" href = "#__docusaurus_skipToContent_fallback" > Skip to main content< / a > < / div > < nav aria-label = "Main" class = "theme-layout-navbar navbar navbar--fixed-top" > < div class = "navbar__inner" > < div class = "theme-layout-navbar-left navbar__items" > < button aria-label = "Toggle navigation bar" aria-expanded = "false" class = "navbar__toggle clean-btn" type = "button" > < svg width = "30" height = "30" viewBox = "0 0 30 30" aria-hidden = "true" > < path stroke = "currentColor" stroke-linecap = "round" stroke-miterlimit = "10" stroke-width = "2" d = "M4 7h22M4 15h22M4 23h22" > < / path > < / svg > < / button > < a class = "navbar__brand" href = "/" > < div class = "navbar__logo" > < img src = "/img/logo.svg" alt = "Podman Desktop Logo" class = "themedComponent_siVc themedComponent--light_hHel" height = "56" > < img src = "/img/logo.svg" alt = "Podman Desktop Logo" class = "themedComponent_siVc themedComponent--dark_yETr" height = "56" > < / div > < b class = "navbar__title text--truncate" > podman desktop< / b > < / a > < a class = "navbar__item navbar__link" href = "/docs/intro" > Documentation< / a > < a class = "navbar__item navbar__link" href = "/downloads" > Downloads< / a > < a class = "navbar__item navbar__link" href = "/community" > Community< / a > < div class = "navbar__item dropdown dropdown--hoverable" > < a href = "#" aria-haspopup = "true" aria-expanded = "false" role = "button" class = "navbar__link" > Resources< / a > < ul class = "dropdown__menu" > < li > < a class = "dropdown__link" href = "/features" > Features< / a > < / li > < li > < a aria-current = "page" class = "dropdown__link dropdown__link--active" href = "/tutorial" > Tutorials< / a > < / li > < li > < a class = "dropdown__link" href = "/extend" > Extend< / a > < / li > < / ul > < / div > < a class = "navbar__item navbar__link" href = "/blog" > Blog< / a > < / div > < div class = "theme-layout-navbar-right navbar__items navbar__items--right" > < a href = "https://github.com/podman-desktop/podman-desktop" target = "_blank" id = "github-stars-button" rel = "noopener noreferrer" class = "navbar__item navbar__link hidden xl:flex items-center gap-2 px-4 mr-3 py-[9px] border border-black dark:border-white rounded-lg font-medium min-w-[9rem] text-base" > < svg data-prefix = "fab" data-icon = "github" class = "svg-inline--fa fa-github" role = "img" viewBox = "0 0 512 512" aria-hidden = "true" > < path fill = "currentColor" d = "M173.9 397 . 4c0 2-2 . 3 3 . 6-5 . 2 3 . 6-3 . 3 . 3-5 . 6-1 . 3-5 . 6-3 . 6 0-2 2 . 3-3 . 6 5 . 2-3 . 6 3- . 3 5 . 6 1 . 3 5 . 6 3 . 6zm-31 . 1-4 . 5c- . 7 2 1 . 3 4 . 3 4 . 3 4 . 9 2 . 6 1 5 . 6 0 6 . 2-2s-1 . 3-4 . 3-4 . 3-5 . 2c-2 . 6- . 7-5 . 5 . 3-6 . 2 2 . 3zm44 . 2-1 . 7c-2 . 9 . 7-4 . 9 2 . 6-4 . 6 4 . 9 . 3 2 2 . 9 3 . 3 5 . 9 2 . 6 2 . 9- . 7 4 . 9-2 . 6 4 . 6-4 . 6- . 3-1 . 9-3-3 . 2-5 . 9-2 . 9zM252 . 8 8c-138 . 7 0-244 . 8 105 . 3-244 . 8 244 0 110 . 9 69 . 8 205 . 8 169 . 5 239 . 2 12 . 8 2 . 3 17 . 3-5 . 6 17 . 3-12 . 1 0-6 . 2- . 3-40 . 4- . 3-61 . 4 0 0-70 15-84 . 7-29 . 8 0 0-11 . 4-29 . 1-27 . 8-36 . 6 0 0-22 . 9-15 . 7 1 . 6-15 . 4 0 0 24 . 9 2 38 . 6 25 . 8 21 . 9 38 . 6 58 . 6 27 . 5 72 . 9 20 . 9 2 . 3-16 8 . 8-27 . 1 16-33 . 7-55 . 9-6 . 2-112 . 3-14 . 3-112 . 3-110 . 5 0-27 . 5 7 . 6-41 . 3 23 . 6-58 . 9-2 . 6-6 . 5-11 . 1-33 . 3 2 . 6-67 . 9 20 . 9-6 . 5 69 27 69 27 20-5 . 6 41 . 5-8 . 5 62 . 8-8 . 5s42 . 8 2 . 9 62 . 8 8 . 5c0 0 48 . 1-33 . 6 69-27 13 . 7 34 . 7 5 . 2 61 . 4 2 . 6 67 . 9 16 17 . 7 25 . 8 31 . 5 25 . 8 58 . 9 0 96 . 5-58 . 9 104 . 2-114 . 8 110 . 5 9 . 2 7 . 9 17 22 . 9 17 46 . 4 0 33 . 7- . 3 75 . 4- . 3 83 . 6 0 6 . 5 4 . 6 14 . 4 17 . 3 12 . 1 100-33 . 2 167 . 8-128 . 1 167 . 8-239 0-138 . 7-112 . 5-244-251 . 2-244zM105 . 2 352 . 9c-1 . 3 1-1 3 . 3 . 7 5 . 2 1 . 6 1 . 6 3 . 9 2 . 3 5 . 2 1 1 . 3-1 1-3 . 3- . 7-5 . 2-1 . 6-1 . 6-3 . 9-2 . 3-5 . 2-1zm-10 . 8-8 . 1c- . 7 1 . 3 . 3 2 . 9 2 . 3 3 . 9 1 . 6 1 3 . 6 . 7 4 . 3- . 7 . 7-1 . 3- . 3-2 . 9-2 . 3-3 . 9-2- . 6-3 . 6- . 3-4 . 3 . 7zm32 . 4 35 . 6c-1 . 6 1 . 3-1 4 . 3 1 . 3 6 . 2 2 . 3 2 . 3 5 . 2 2 . 6 6 . 5 1 1 . 3-1 . 3 . 7-4 .
2025-01-23 15:49:19 +00:00
< header > < h1 > What are Testcontainers< / h1 > < / header >
2025-11-05 20:28:25 +00:00
< p > < a href = "https://testcontainers.com/" target = "_blank" rel = "noopener noreferrer" class = "" > Testcontainers< / a > is an open source library that allows you to test any containerized dependencies, such as databases, various cloud technologies, or message brokers. For ease of use, Testcontainers has many preconfigured dependencies called modules.< / p >
2025-01-23 15:49:19 +00:00
< p > Besides that, Testcontainers supports various languages in which you can easily write your tests, such as Python, Go, Rust, Ruby, JavaScript, .NET, Java, and others.< / p >
2025-11-05 20:28:25 +00:00
< h2 class = "anchor anchorTargetStickyNavbar_tleR" id = "common-use-cases-with-testcontainers" > Common use cases with Testcontainers< a href = "#common-use-cases-with-testcontainers" class = "hash-link" aria-label = "Direct link to Common use cases with Testcontainers" title = "Direct link to Common use cases with Testcontainers" translate = "no" > < / a > < / h2 >
2025-01-23 15:49:19 +00:00
< p > Thanks to the container technology, you can obtain fresh, clean instances without any complex setup for use cases such as:< / p >
< ul >
2025-11-05 20:28:25 +00:00
< li class = "" > Data access layer integration tests< / li >
< li class = "" > UI/Acceptance tests< / li >
< li class = "" > Application integration tests< / li >
2025-01-23 15:49:19 +00:00
< / ul >
2025-11-05 20:28:25 +00:00
< h2 class = "anchor anchorTargetStickyNavbar_tleR" id = "setup-testcontainers-with-podman" > Setup Testcontainers with Podman< a href = "#setup-testcontainers-with-podman" class = "hash-link" aria-label = "Direct link to Setup Testcontainers with Podman" title = "Direct link to Setup Testcontainers with Podman" translate = "no" > < / a > < / h2 >
< p > Before we start, you need to have installed < a href = "https://podman.io/" target = "_blank" rel = "noopener noreferrer" class = "" > Podman< / a > and run it in socket listening:< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-shell codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-shell codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > $ < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > podman< / span > < span class = "token plain" > system < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > service< / span > < span class = "token plain" > < / span > < span class = "token parameter variable" style = "color:rgb(189, 147, 249);font-style:italic" > --time< / span > < span class = "token operator" > =< / span > < span class = "token number" > 0< / span > < span class = "token plain" > < / span > < span class = "token operator" > & < / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< p > Set Testcontainers runtime to Podman by using one of the following options:< / p >
< ul >
2025-11-05 20:28:25 +00:00
< li class = "" >
< p > Enable the < a href = "https://podman-desktop.io/docs/migrating-from-docker/managing-docker-compatibility" target = "_blank" rel = "noopener noreferrer" class = "" > Docker Compatibility< / a > feature.< / p >
2025-01-23 15:49:19 +00:00
< / li >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Create a < code > .testcontainers.properties< / code > file in your home directory for global configuration of your Testcontainers and add the following line to the configuration file:< / p >
< ul >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > MacOS< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-title=".testcontainers.properties" codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-title=".testcontainers.properties" codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > docker.host=unix://$(podman machine inspect --format ' {{.ConnectionInfo.PodmanSocket.Path}}' )< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< p > Run the following command after configuration:< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-bash codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-bash codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > $ < / span > < span class = "token builtin class-name" style = "color:rgb(189, 147, 249)" > export< / span > < span class = "token plain" > < / span > < span class = "token assign-left variable" style = "color:rgb(189, 147, 249);font-style:italic" > TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE< / span > < span class = "token operator" > =< / span > < span class = "token plain" > /var/run/docker.sock< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< / li >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Linux:< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-title=".testcontainers.properties" codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-title=".testcontainers.properties" codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > docker.host=unix://${XDG_RUNTIME_DIR}/podman/podman.sock< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< div class = "theme-admonition theme-admonition-note admonition_WCGJ alert alert--secondary" > < div class = "admonitionHeading_GCBg" > < span class = "admonitionIcon_L39b" > < svg viewBox = "0 0 14 16" > < path fill-rule = "evenodd" d = "M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z" > < / path > < / svg > < / span > note< / div > < div class = "admonitionContent_pbrs" > < p > Every language supported by Testcontainers has different properties supported by the .testcontainers.properties file.< / p > < / div > < / div >
< / li >
< / ul >
< / li >
< / ul >
< blockquote >
< p > < strong > < em > OPTIONAL:< / em > < / strong > If you are running Podman in rootless mode, you must disable Ryuk by defining this environment variable:< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-bash codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-bash codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > $ < / span > < span class = "token builtin class-name" style = "color:rgb(189, 147, 249)" > export< / span > < span class = "token plain" > < / span > < span class = "token assign-left variable" style = "color:rgb(189, 147, 249);font-style:italic" > TESTCONTAINERS_RYUK_DISABLED< / span > < span class = "token operator" > =< / span > < span class = "token plain" > true< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< / blockquote >
2025-11-05 20:28:25 +00:00
< h2 class = "anchor anchorTargetStickyNavbar_tleR" id = "creating-a-project" > Creating a project< a href = "#creating-a-project" class = "hash-link" aria-label = "Direct link to Creating a project" title = "Direct link to Creating a project" translate = "no" > < / a > < / h2 >
2025-01-23 15:49:19 +00:00
< p > This example uses the Redis service and Redis module from Testcontainers. You can create a project and install all the dependencies by following the procedure.< / p >
< ol >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Initialize a project.< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-bash codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-bash codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > $ < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > npm< / span > < span class = "token plain" > init < / span > < span class = "token parameter variable" style = "color:rgb(189, 147, 249);font-style:italic" > -y< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< / li >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Installing dependencies.< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-bash codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-bash codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > $ < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > npm< / span > < span class = "token plain" > < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > install< / span > < span class = "token plain" > testcontainers vitest @testcontainers/redis redis typescript --save-dev< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< / li >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Update < code > package.json< / code > file.< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-json codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockTitle_kY6l" > package.json< / div > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-json codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > ...< / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token property" > " scripts" < / span > < span class = "token operator" > :< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token property" > " test" < / span > < span class = "token operator" > :< / span > < span class = "token plain" > < / span > < span class = "token string" style = "color:rgb(255, 121, 198)" > " vitest" < / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > ...< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< / li >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Create basic CRUD operations using the Redis Node.js library.< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-ts codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockTitle_kY6l" > index.ts< / div > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-ts codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > import< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > createClient< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > RedisClientType < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > from< / span > < span class = "token plain" > < / span > < span class = "token string" style = "color:rgb(255, 121, 198)" > ' redis' < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ;< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" style = "display:inline-block" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > let< / span > < span class = "token plain" > redisClient< / span > < span class = "token operator" > :< / span > < span class = "token plain" > RedisClientType < / span > < span class = "token operator" > |< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > undefined< / span > < span class = "token plain" > < / span > < span class = "token operator" > =< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > undefined< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ;< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" style = "display:inline-block" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > export< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > async< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > function< / span > < span class = "token plain" > < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > connectRedis< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > (< / span > < span class = "token plain" > url< / span > < span class = "token operator" > :< / span > < span class = "token plain" > < / span > < span class = "token builtin" style = "color:rgb(189, 147, 249)" > string< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > )< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > redisClient < / span > < span class = "token operator" > =< / span > < span class = "token plain" > < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > createClient< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > (< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > url < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > )< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ;< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147 , 249 ) ; fo
2025-01-23 15:49:19 +00:00
< / li >
2025-11-05 20:28:25 +00:00
< li class = "" >
2025-01-23 15:49:19 +00:00
< p > Create basic tests for CRUD operations.< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-ts codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockTitle_kY6l" > index.spec.ts< / div > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-ts codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > import< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > afterAll< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > beforeAll< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > beforeEach< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > expect< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > test < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > from< / span > < span class = "token plain" > < / span > < span class = "token string" style = "color:rgb(255, 121, 198)" > ' vitest' < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ;< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > import< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > connectRedis< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > deleteValue< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > disconnectRedis< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > getValue< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > setValue < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > from< / span > < span class = "token plain" > < / span > < span class = "token string" style = "color:rgb(255, 121, 198)" > ' .' < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ;< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > import< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > RedisContainer< / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ,< / span > < span class = "token plain" > StartedRedisContainer < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > from< / span > < span class = "token plain" > < / span > < span class = "token string" style = "color:rgb(255, 121, 198)" > ' @testcontainers/redis' < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > ;< / span > < span class = "token plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > < / span > < span class = "token keyword" style = "color:rgb(189, 147, 249);font-style:italic" > import< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > {< / span > < span class = "token plain" > Wait < / span > < span class = "token punctuation" style = "color:rgb(248, 248, 242)" > }< / span > < span class = "token pl
2025-01-23 15:49:19 +00:00
< / li >
< / ol >
2025-11-05 20:28:25 +00:00
< h2 class = "anchor anchorTargetStickyNavbar_tleR" id = "running-tests" > Running tests< a href = "#running-tests" class = "hash-link" aria-label = "Direct link to Running tests" title = "Direct link to Running tests" translate = "no" > < / a > < / h2 >
2025-01-23 15:49:19 +00:00
< p > When running Testcontainers for the first time, ensure that you run your tests in < code > DEBUG< / code > mode by using this command:< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-bash codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-bash codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > $ < / span > < span class = "token assign-left variable" style = "color:rgb(189, 147, 249);font-style:italic" > DEBUG< / span > < span class = "token operator" > =< / span > < span class = "token plain" > testcontainers* < / span > < span class = "token function" style = "color:rgb(80, 250, 123)" > npm< / span > < span class = "token plain" > < / span > < span class = "token builtin class-name" style = "color:rgb(189, 147, 249)" > test< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< p > Then, you should be able to see lines similar to the ones below:< / p >
2025-09-08 13:08:00 +00:00
< div class = "language-text codeBlockContainer_mQmQ theme-code-block" style = "--prism-color:#F8F8F2;--prism-background-color:#282A36" > < div class = "codeBlockContent_t_Hd" > < pre tabindex = "0" class = "prism-code language-text codeBlock_RMoD thin-scrollbar" style = "color:#F8F8F2;background-color:#282A36" > < code class = "codeBlockLines_AclH" > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > testcontainers [DEBUG] Loading " .testcontainers.properties" file...< / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > testcontainers [DEBUG] Loaded " .testcontainers.properties" file< / span > < br > < / span > < span class = "token-line" style = "color:#F8F8F2" > < span class = "token plain" > testcontainers [DEBUG] Found custom configuration: dockerHost: " unix:///run/user/1000//podman/podman.sock< / span > < br > < / span > < / code > < / pre > < / div > < / div >
2025-01-23 15:49:19 +00:00
< p > Those lines indicate that Testcontainers found the configuration file, and the containers are created on the Podman engine instead of Docker.< / p >
2025-11-05 20:28:25 +00:00
< h2 class = "anchor anchorTargetStickyNavbar_tleR" id = "conclusion" > Conclusion< a href = "#conclusion" class = "hash-link" aria-label = "Direct link to Conclusion" title = "Direct link to Conclusion" translate = "no" > < / a > < / h2 >
< p > This tutorial provides a basic step-by-step walkthrough using the Testcontainers technology to run a < a href = "https://redis.io/" target = "_blank" rel = "noopener noreferrer" class = "" > Redis< / a > server with Podman. More examples can be found in the guides of < a href = "https://testcontainers.com/guides/" target = "_blank" rel = "noopener noreferrer" class = "" > Testcontainers< / a > . If you encounter any problems, feel free to open an issue on Podman Desktop' s < a href = "https://github.com/podman-desktop/podman-desktop/issues" target = "_blank" rel = "noopener noreferrer" class = "" > GitHub< / a > .< / p > < / div > < footer class = "theme-doc-footer docusaurus-mt-lg" > < div class = "row margin-top--sm theme-doc-footer-tags-row" > < div class = "col" > < b > Tags:< / b > < ul class = "tags_Ow0B padding--none margin-left--sm" > < li class = "tag_DFxh" > < a rel = "tag" class = "tag_otG2 tagRegular_s0E1" href = "/tutorial/tags/podman" > podman< / a > < / li > < li class = "tag_DFxh" > < a rel = "tag" class = "tag_otG2 tagRegular_s0E1" href = "/tutorial/tags/podman-desktop" > podman-desktop< / a > < / li > < li class = "tag_DFxh" > < a rel = "tag" class = "tag_otG2 tagRegular_s0E1" href = "/tutorial/tags/containers" > containers< / a > < / li > < li class = "tag_DFxh" > < a rel = "tag" class = "tag_otG2 tagRegular_s0E1" href = "/tutorial/tags/testcontainers" > testcontainers< / a > < / li > < li class = "tag_DFxh" > < a rel = "tag" class = "tag_otG2 tagRegular_s0E1" href = "/tutorial/tags/tests" > tests< / a > < / li > < / ul > < / div > < / div > < / footer > < / article > < nav class = "docusaurus-mt-lg pagination-nav" aria-label = "Docs pages" > < a class = "pagination-nav__link pagination-nav__link--prev" href = "/tutorial/getting-started-with-compose" > < div class = "pagination-nav__sublabel" > Previous< / div > < div class = "pagination-nav__label" > Getting started with Compose< / div > < / a > < / nav > < / div > < / div > < div class = "col col--3" > < div class = "tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop" > < ul class = "table-of-contents table-of-contents__left-border" > < li > < a href = "#common-use-cases-with-testcontainers" class = "table-of-contents__link toc-highlight" > Common use cases with Testcontainers< / a > < / li > < li > < a href = "#setup-testcontainers-with-podman" class = "table-of-contents__link toc-highlight" > Setup Testcontainers with Podman< / a > < / li > < li > < a href = "#creating-a-project" class = "table-of-contents__link toc-highlight" > Creating a project< / a > < / li > < li > < a href = "#running-tests" class = "table-of-contents__link toc-highlight" > Running tests< / a > < / li > < li > < a href = "#conclusion" class = "table-of-contents__link toc-highlight" > Conclusion< / a > < / li > < / ul > < / div > < / div > < / div > < / div > < / main > < / div > < / div > < / div > < footer class = "theme-layout-footer footer" > < div class = "container container-fluid" > < div class = "row footer__links" > < div class = "theme-layout-footer-column col footer__col" > < div class = "footer__title" > Documentation< / div > < ul class = "footer__items clean-list" > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/installation" > Installing Podman Desktop< / a > < / li > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/migrating-from-docker" > Migrating from Docker< / a > < / li > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/kubernetes" > Working with Kubernetes< / a > < / li > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/troubleshooting" > Troubleshooting< / a > < / li > < / ul > < / div > < div class = "theme-layout-footer-column col footer__col" > < div class = "footer__title" > Links< / div > < ul class = "footer__items clean-list" > < li class = "footer__item" > < a href = "https://github.com/podman-desktop/podman-desktop" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > GitHub< svg width = "13.5" height = "13.5" aria-label = "(opens in new tab)" class = "iconExternalLink_nPrP" > < use href = "#theme-svg-external-link" > < / use > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://discord.com/invite/x5GzFF6QH4" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Chat (bridged): #podman-desktop on Discord< svg width = "13.5" height = "13.5" aria-label = "(opens in new tab)" class = "iconExternalLink_nPrP" > < use href = "#theme-svg-external-link" > < / use > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://github.com/podman-desktop/podman-desktop#communicati
2025-04-14 17:49:47 +00:00
< div class = "flex flex-col items-start text-left gap-4" >
< div class = "w-96 mt-8 mb-8" >
< img class = "dark:hidden" alt = "Cloud Native Computing Foundation" src = "/img/cncf-logo.svg" >
< img class = "hidden dark:inline" alt = "Cloud Native Computing Foundation" src = "/img/cncf-logo-dark.svg" >
< / div >
< div class = "text-sm" >
< p class = "mb-1" > We are a < a href = "https://cncf.io/" class = "underline" > Cloud Native Computing Foundation< / a > sandbox project.< / p >
2026-01-02 09:09:39 +00:00
< p class = "mb-1" > © Copyright Podman Desktop Contributors 2026. © 2026 The Linux Foundation. All rights reserved.< / p >
2025-04-14 17:49:47 +00:00
< p class = "mb-1" > The Linux Foundation has registered trademarks and uses trademarks.
For a list of trademarks of The Linux Foundation, please see our
< a href = "https://www.linuxfoundation.org/trademark-usage/" class = "underline" > Trademark Usage< / a > page.< / p >
< / div >
< / div >
< / div > < / div > < / div > < / footer > < / div >
2025-01-23 15:49:19 +00:00
< / body >
< / html >
