Fix "Code sniff" step in CI and other updates #92
Conversation
jabxjab
force-pushed
the
feature/ci-code-validation
branch
from
80c7144
to
6f6c2e2
Compare
jabxjab
changed the title
| ]; | ||
| } | ||
|
|
||
| parent::__construct($options); |
There was a problem hiding this comment.
updated to respect parent's constructor call
| public function __construct(LoggerChannelFactoryInterface $loggerChannelFactory, PantheonGuzzle $pantheonGuzzle) { | ||
| $this->logger = $loggerChannelFactory->get('PantheonSolr'); | ||
| $this->client = $pantheonGuzzle; | ||
| public function __construct(LoggerChannelFactoryInterface $logger_channel_factory, PantheonGuzzle $pantheon_guzzle_client) { |
There was a problem hiding this comment.
As per Drupal's var name best practices, all var and arg names are in snake case, while class properties are in camelcase.
| foreach ($files as $filename => $file_contents) { | ||
| try { | ||
| $response = $this->uploadSchemaFile($filename, $file_contents); | ||
| $logFunction = in_array($response->getStatusCode(), [200, 201, 202, 203]) ? 'notice' : 'error'; |
There was a problem hiding this comment.
This check is not needed because Guzzle throws exceptions on non-200 statuses
| $toReturn[] = $message; | ||
| $this->getLogger()->{$logFunction}($message); | ||
| $output[] = $message; | ||
| $this->logger->debug($message); |
There was a problem hiding this comment.
Seems like "'File: %s, Status code: %d - %s'" is a debug, so logging this as a debug log
| * @return \Psr\Http\Client\ClientInterface | ||
| * Psr 18 Client, typically PantheonGuzzle instance. | ||
| */ | ||
| public function getClient(): PSR18Interface { |
There was a problem hiding this comment.
Removing client in order to incapsulate and use ->client directly
| * @return \Psr\Log\LoggerInterface | ||
| * PSR Logger interface. | ||
| */ | ||
| public function getLogger(): LoggerInterface { |
There was a problem hiding this comment.
Removing this in favor of LoggerChannelTrait (and setting up in the constructor)
| } | ||
|
|
||
| /** | ||
| * Get verbosity. | ||
| * | ||
| * @return bool | ||
| * Wheither or not to turn on long debugging. | ||
| * Whether or not to turn on long debugging. | ||
| */ | ||
| protected function isVerbose(): bool { |
There was a problem hiding this comment.
Not used as of now, needs to be deleted.
| @@ -35,8 +34,11 @@ jobs: | |||
| mkdir -p /root/.ssh && echo "StrictHostKeyChecking no" >> "/root/.ssh/config" | |||
| terminus auth:login -n --machine-token="$TERMINUS_TOKEN" | |||
|
|
|||
| - name: Composer install | |||
There was a problem hiding this comment.
In order to run phpcs, composer installation neede
| - name: Code sniff | ||
| run: ./vendor/bin/phpcs --report=full --standard=vendor/drupal/coder/coder_sniffer/Drupal . --ignore=vendor | ||
| run: composer run-script code:lint |
There was a problem hiding this comment.
Better to use already defined composer run-script
…onSolrConnector::getDefaultEndpoint()
| public function postSchema(string $server_id = 'pantheon_solr8') { | ||
| public function postSchema(?string $server_id = NULL) { | ||
| if (!$server_id) { | ||
| $server_id = PantheonSolrConnector::getDefaultEndpoint(); |
There was a problem hiding this comment.
Remove hardcoded value in favor of the canonical one
| @@ -273,7 +278,7 @@ public function viewSchema(string $filename = 'schema.xml') { | |||
| if (!$schemaPoster instanceof SchemaPoster) { | |||
| throw new \Exception('Cant get Schema Poster class. Something is wrong with the container.'); | |||
| } | |||
| $currentSchema = $schemaPoster->viewSchema('pantheon_solr8', $filename); | |||
| $currentSchema = $schemaPoster->viewSchema($filename); | |||
There was a problem hiding this comment.
server_id is not needed (not used) in viewSchema() anymore, so removing
| */ | ||
| public function getSolrFiles(string $server_id = 'pantheon_solr8') { | ||
| protected function getSolrFiles(string $server_id) { |
There was a problem hiding this comment.
making protected since not used outside
|
|
||
| $this->setLogger($loggerChannel->get('PantheonGuzzle')); |
There was a problem hiding this comment.
Removing logger since not used
jabxjab
force-pushed
the
feature/ci-code-validation
branch
from
55b1947
to
fce337c
Compare
| $guzzle = new PantheonGuzzle($loggerChannel); | ||
| $queryResult = $guzzle->getSolrClient()->update($query); | ||
| $this->assertTrue($queryResult->getResponse->getStatusCode() == 200); | ||
| $pantheon_guzzle = new PantheonGuzzle(); |
| @@ -20,8 +20,10 @@ | |||
| }, | |||
| "autoload-dev": { | |||
| "psr-4": { | |||
| "Drupal\\search_api_pantheon\\" : "./src", | |||
| "Drupal\\search_api_pantheon\\tests\\" : "./tests" | |||
| "Drupal\\search_api_pantheon\\" : "src/", | |||
There was a problem hiding this comment.
Without this phpunit won't find search_api_* related resources on my local
| ./setup-d8-repo.sh | ||
| ./enable-modules.sh | ||
| ./verify-solr.sh | ||
| # - name: Tests |
There was a problem hiding this comment.
commenting out since does not work currently
No description provided.