CheckInx Utils

You can check your query execution plan really simple by using this utils. Your tests could be look like:

class DbIntensiveIntegrationTests : AbstractIntegrationTest() {
    @Autowired
    private lateinit var executionPlanQuery: ExecutionPlanQuery
    @Autowired
    private lateinit var executionPlanParser: ExecutionPlanParser
    @Autowired
    private lateinit var checkInxAssertService: CheckInxAssertService
    @Autowired
    private lateinit var sqlInterceptor: SqlInterceptor
    
    // If you want to get truthful execution plan, generate enough test data
    @Sql("pets.sql") // do it by db dump ...
    @Test
    fun testFindByLocation() {
       // ARRANGE
       val location = "Moscow"
    
       // ... or generate test data by code
       IntRange(1, 10000).forEach {
           val pet = Pet()
           pet.id = UUID.randomUUID()
           pet.age = it
           pet.location = "Saint Petersburg"
           pet.name = "Jack-$it"
    
           repository.save(pet)
       }
    
       // ACT
    
       // After all arrangements start interception of sql statements
       sqlInterceptor.startInterception()
    
       // Your investigation might be here
       val pets = repository.findByLocation(location)
    
       // After all investigating queries finished stop interception
       sqlInterceptor.stopInterception()
    
       // ASSERT
    
       // Here you can check how many queries were executed
       assertEquals(1, sqlInterceptor.statements.size.toLong())
    
       // If you want something spicy, you can parse raw plan on your own ...
       val executionPlan = executionPlanQuery.execute(sqlInterceptor.statements[0])
       assertTrue(executionPlan.isNotEmpty())
    
       // ... or travers plan tree ...
       val plan = executionPlanParser.parse(executionPlan)
       assertNotNull(plan)
    
       val rootNode = plan.rootPlanNode
       assertEquals("Index Scan", rootNode.coverage)
       assertEquals("ix_pets_location", rootNode.target)
       assertEquals("pets pet0_", rootNode.table)
    
       // Now assert coverage is simple like never before ...
       checkInxAssertService.assertCoverage(CoverageLevel.HALF, "ix_pets_location", plan)
    
       // One more thing, it even could be more simple ...
       checkInxAssertService.assertCoverage(CoverageLevel.HALF, "ix_pets_location", sqlInterceptor.statements[0])
    
       // ... or if you just want to prevent "seq scan" for example, without searching concrete index
       checkInxAssertService.assertCoverage(CoverageLevel.HALF, sqlInterceptor.statements[0])
    }
}

Look at the demo repository to find more examples.

Starting guide

I’m going to publish checkinx in maven repository. Until I’ve done it use jitpack to get artifacts from github.

Firstly, modify your build.gradle and add new repository

repositories {
  // ...
   maven { url 'https://jitpack.io' }
}

Secondly, add new dependency (please checkout for latest release here)

dependencies {
// ...
   implementation 'com.github.tinkoffcreditsystems:checkinx-utils:0.2.0'
}

Finally, add beans & BeanPostProcessor to your configuration

@Profile("test")
@ImportAutoConfiguration(classes = [PostgresConfig::class])
@Configuration
open class CheckInxConfig

For now, only Postgres is supported, but you can easily change it. Just make pull request ;-).

Be sure that you are using org.testcontainers. Its DB version and configuration equal your real DB.

Now you are ready to create your first “intensive” integration test.

Known issues

Sometimes DataSourceWrapper could fail to replace dataSource because of Spring CGLIB proxy. The easiest workaround is to create HikariDataSource bean manually:

@Profile("test")
@ImportAutoConfiguration(classes = [PostgresConfig::class])
@Configuration
open class CheckInxConfig {
    @Primary
    @Bean
    @ConfigurationProperties("spring.datasource")
    open fun dataSource(): DataSource {
        return DataSourceBuilder.create()
            .type(HikariDataSource::class.java)
            .build()
    }

    @Bean
    @ConfigurationProperties("spring.datasource.configuration")
    open fun dataSource(properties: DataSourceProperties): HikariDataSource {
        return properties.initializeDataSourceBuilder()
            .type(HikariDataSource::class.java)
            .build()
    }
}

Contribution

If you have time and ideas how to improve checkinx, welcome! I’ll be really happy if you decide to join and contribute.

Hope you'll like it.